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

第flask路由分模塊管理及自定義restful響應格式詳解目錄一、flask路由分模塊管理1.1、使用藍圖1.2、使用flask_restful二、自定義flask_restful響應格式

一、flask路由分模塊管理

1.1、使用藍圖

在flask中可以使用藍圖Blueprint來進行創(chuàng)建路由進行分模塊。具體操作，我們可以在項目根目錄下創(chuàng)建一個controller文件夾來存儲分模塊的路由。

在controller文件夾里創(chuàng)建product_controller.py，在里面如下寫法引入藍圖，并且注冊藍圖：

fromflaskimportBlueprint

product_blue=Blueprint('product',__name__)

#定義藍圖路徑及請求方法和請求返回邏輯

@product_blue.route('/get',methods=['get','post'])

defgetproduct():

return'product'

@product_blue.route('/search',methods=['get','post'])

defsearchproduct():

return'search'

那么我們在項目主邏輯文件main.py中，去引入并注冊這個藍圖：

fromflaskimportFlask

fromduct_controllerimportproduct_blue

app=Flask(__name__)

#商品模塊

app.register_blueprint(product_blue,url_prefix='/product')

if__name__=='__main__':

app.run()

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

可以看到我們使用藍圖分模塊的創(chuàng)建已經(jīng)生效了，這樣如果模塊對的話，我們就方便管理了。不會造成代碼全部冗余在一個主文件中。

1.2、使用flask_restful

那么相比與藍圖Blueprint，flask_restful的優(yōu)勢就在于它能夠做更多的操作，比如參數(shù)的驗證，返回直接字典就能解析成json。

首先我們輸入命令pip3installflask_restful安裝flask_restful。在product_controller中寫入如下代碼：

fromflask_restfulimportResource,reqparse

classProductView(Resource):

@staticmethod

defpost():

parse=reqparse.RequestParser()

parse.add_argument('product_id',type=str,help='商品id必傳',required=True,trim=True)

args=parse.parse_args()

product_id=duct_id

return{

'msg':'商品id是'+product_id,

'code':200

@staticmethod

defget():

return{

'msg':'商品',

'code':200

那么main.py主文件中修改如下：

fromduct_controllerimportProductView

app=Flask(__name__)

api=Api(app)

api.add_resource(ProductView,'/product',endpoint='product')

if__name__=='__main__':

app.run()

現(xiàn)在已經(jīng)是restful形式的api了，我們采用apifox或者postman測試請求接口如下：

可以看到get請求成功，但是在post請求時，我們沒有傳必傳參數(shù)，所以出現(xiàn)了報錯。我們嘗試將必傳參數(shù)加上：

那么可以看到將必傳的參數(shù)加上后，請求成功。兩種模式可以共存，但是一般我們只用一種就行了。

相信細心的小伙伴已經(jīng)發(fā)現(xiàn)，失敗和成功返回的數(shù)據(jù)格式不一樣，成功有code，失敗卻沒有code，那么我想自定義失敗返回的數(shù)據(jù)格式，將怎么操作呢，接下來自定義flask_restful的錯誤響應。

二、自定義flask_restful響應格式

在根目錄下創(chuàng)建errors.py，寫入如下代碼：

"""

designthecustomerrorresponseofflask-restful

fromflask_restfulimportabort

defgenerate_response(msg,status):

return{

'code':status,

'msg':msg,

defcustom_abort(http_status_code,*args,**kwargs):

ifhttp_status_code==400:

abort(400,**generate_response(msg=[kwargs.get('message')],status=http_status_code))

abort(http_status_code)

我們將錯誤狀態(tài)拎出來自定義返回格式。在main.py主文件中加入這兩行代碼：

fromerrorsimportcustom_abort

flask_restful.abort=c