flask路由分模組管理及自定義restful響應格式詳解

2022-08-18 14:01:30

一、flask路由分模組管理

1.1、使用藍圖

在flask中可以使用藍圖Blueprint來進行建立路由進行分模組。具體操作，我們可以在專案根目錄下建立一個controller資料夾來儲存分模組的路由。

在controller資料夾裡建立product_controller.py，在裡面如下寫法引入藍圖，並且註冊藍圖：

from flask import Blueprint
product_blue = Blueprint('product', __name__)
# 定義藍圖路徑及請求方法和請求返回邏輯
@product_blue.route('/get', methods=['get', 'post'])
def getproduct():
	return 'product'
@product_blue.route('/search', methods=['get', 'post'])
def searchproduct():
	return 'search'

那麼我們在專案主邏輯檔案main.py中，去引入並註冊這個藍圖：

from flask import Flask
from controller.product_controller import product_blue
app = Flask(__name__)
# 商品模組
app.register_blueprint(product_blue, url_prefix='/product')
if __name__ == '__main__':
    app.run()

接下來我們執行程式，可以看到如下效果：

可以看到我們使用藍圖分模組的建立已經生效了，這樣如果模組對的話，我們就方便管理了。不會造成程式碼全部冗餘在一個主檔案中。

1.2、使用flask_restful

那麼相比與藍圖Blueprint，flask_restful的優勢就在於它能夠做更多的操作，比如引數的驗證，返回直接字典就能解析成json。

首先我們輸入命令pip3 install flask_restful安裝flask_restful。在product_controller中寫入如下程式碼：

from flask_restful import Resource, reqparse
class ProductView(Resource):
    @staticmethod
    def post():
        parse = reqparse.RequestParser()
        parse.add_argument('product_id', type=str, help='商品id必傳', required=True, trim=True)
        args = parse.parse_args()
        product_id = args.product_id
        return {
            'msg': '商品id是' + product_id,
            'code': 200
        }
    @staticmethod
    def get():
        return {
            'msg': '商品',
            'code': 200
        }

那麼main.py主檔案中修改如下：

from controller.product_controller import ProductView
app = Flask(__name__)
api = Api(app)
api.add_resource(ProductView, '/product', endpoint='product')
if __name__ == '__main__':
    app.run()

現在已經是restful形式的api了，我們採用apifox或者postman測試請求介面如下：

可以看到get請求成功，但是在post請求時，我們沒有傳必傳引數，所以出現了報錯。我們嘗試將必傳引數加上：

那麼可以看到將必傳的引數加上後，請求成功。兩種模式可以共存，但是一般我們只用一種就行了。

相信細心的小夥伴已經發現，失敗和成功返回的資料格式不一樣，成功有code，失敗卻沒有code，那麼我想自定義失敗返回的資料格式，將怎麼操作呢，接下來自定義flask_restful的錯誤響應。

二、自定義flask_restful響應格式

在根目錄下建立errors.py，寫入如下程式碼：

"""
design the custom error response of flask-restful
"""
from flask_restful import abort
def generate_response(msg, status):
    return {
            'code': status,
            'msg': msg,
        }
def custom_abort(http_status_code, *args, **kwargs):
    if http_status_code == 400:
        abort(400, **generate_response(msg=[kwargs.get('message')], status=http_status_code))
    abort(http_status_code)

我們將錯誤狀態拎出來自定義返回格式。在main.py主檔案中加入這兩行程式碼：

from errors import custom_abort
flask_restful.abort = custom_abort

效果如下：

可以看到我們成功的返回了相同的資料結構。

以上就是flask路由分模組管理及自定義restful響應格式詳解的詳細內容，更多關於flask路由管理restful響應格式的資料請關注it145.com其它相關文章！

flask路由分模組管理及自定義restful響應格式詳解

目錄

一、flask路由分模組管理

1.1、使用藍圖

1.2、使用flask_restful

二、自定義flask_restful響應格式

熱門文章