Flask 用于 API 的方法視圖

2021-08-10 17:54 更新

Web API 的工作通常與 HTTP 動詞緊密相關，所以這使得實現(xiàn)這樣一個基于 MethodView 類的 API 很有意義。也就是說，你會注意到大多數時候， API 需要不同的 URL 規(guī)則來訪問相同的方法視圖。譬如，想象一種情況，你在 web 上暴露一個用戶對象:

URL	HTTP 方法	描述
/users/	GET	獲得全部用戶的列表
/users/	POST	創(chuàng)建一個新用戶
/users/<id>	GET	顯示某個用戶
/users/<id>	PUT	更新某個用戶
/users/<id>	DELETE	刪除某個用戶

那么，你會想用 MethodView 做什么？訣竅是利用你可以對相同的視圖提供多個規(guī)則的事實。

讓我們假設這時視圖看起來是這個樣子:

class UserAPI(MethodView):

    def get(self, user_id):
        if user_id is None:
            # return a list of users
            pass
        else:
            # expose a single user
            pass

    def post(self):
        # create a new user
        pass

    def delete(self, user_id):
        # delete a single user
        pass

    def put(self, user_id):
        # update a single user
        pass

如此，我們怎樣把它掛載到路由系統(tǒng)中？添加兩條規(guī)則，并且為每條規(guī)則顯式地指出 HTTP 方法:

user_view = UserAPI.as_view('user_api')
app.add_url_rule('/users/', defaults={'user_id': None},
                 view_func=user_view, methods=['GET',])
app.add_url_rule('/users/', view_func=user_view, methods=['POST',])
app.add_url_rule('/users/<int:user_id>', view_func=user_view,
                 methods=['GET', 'PUT', 'DELETE'])

如果你有許多看起來類似的 API ，你可以重構上述的注冊代碼:

def register_api(view, endpoint, url, pk='id', pk_type='int'):
    view_func = view.as_view(endpoint)
    app.add_url_rule(url, defaults={pk: None},
                     view_func=view_func, methods=['GET',])
    app.add_url_rule(url, view_func=view_func, methods=['POST',])
    app.add_url_rule('%s<%s:%s>' % (url, pk_type, pk), view_func=view_func,
                     methods=['GET', 'PUT', 'DELETE'])

register_api(UserAPI, 'user_api', '/users/', pk='user_id')

以上內容是否對您有幫助：

← Flask 裝飾視圖

Flask 應用上下文 →

寫筆記

我要補充