Restful 路由 - Flask API 範例

Restful 路由是為了使路由在所有不同的應用程式中保持一致。 REST 是表述性狀態轉移。它以一致的、人類可讀的、機器可讀的方式使用 HTTP。

標準是 GET、POST、PATCH、PUT 和 DELETE。

下面將給出一個 Flask API 資料庫中的幾個靜態路由的範例，用於從前端獲取/向前端提供資訊並執行所需的操作。

使用 Flask 在伺服器端取得使用者的範例使用以下程式碼。

首先您還需要匯入這些項目。稍後將在 DELETE 範例中使用 db 導入。

from flask import request (*Used for POST and PATCH*)
from config import db, api, app 

from flask_restful import Resource
from models.user import User

您的設定檔應如下所示設定才能使匯入正常運作。

 db = SQLAlchemy(app=app, metadata=metadata)
 api = Api(app=app)

使用者路由中的​​ GET 代碼：

 class UsersResource(Resource):
     def get(self):
        users = [user.to_dict() for user in User.query.all()]
        return users, 200

 api.add_resource(UsersResource, "/api/users", endpoint="users")

分解此程式碼。

您需要為使用者資源建立一個類別並將資源作為參數放入。

接下來為 get 建立一個函數。該函數將查詢用戶表，然後建立所有用戶的列表，並將其轉換為字典進行傳輸，以便它們可以在網頁上以 JSON 形式可見。然後，您返回該清單以及表示請求成功的狀態代碼 200。

最後您需要建立資源。命名您正在使用的資源以及路徑和端點。在路徑前面新增/api，以便託管網站能夠辨別前後端路由。

對於 DELETE，您必須為單一使用者刪除建立另一個資源。請參考以下程式碼：

 class UserResource(Resource):
     def delete(self, id):
         user= User.query.get(id)
         db.session.delete(user)
         db.session.commit()
         return {}, 204

 api.add_resource(UserResource, "/api/user/<int:id>", 
 endpoint="user")

為了進一步解釋刪除中發生的與獲取不同的事情，有幾件事。首先，它只是刪除一個用戶，因此您需要建立一個新資源。它的設定類似但不是複數。

然後建立刪除函數。它需要兩個參數，因為您需要傳入從前端發送的 id 來決定要刪除哪個使用者。然後您將使用 db session delete 並 commit 來更新資料庫。之後，您會傳回一個空響應，因為沒有任何內容可傳回以及刪除狀態 (204)。

最後您需要建立資源。這次使用 UserResource。該路徑將有所不同，為單一的，並且具有傳遞到前端的 id，並且端點也是單一的。

RESTful 路由使得在不同應用程式之間切換時有一個標準，每個人都可以遵循後端路由並知道標準化的路徑。此外，它使路徑更清晰、更易於閱讀。

以上是Restful 路由 - Flask API 範例的詳細內容。更多資訊請關注PHP中文網其他相關文章！