flask路由分模塊管理及自定義restful響應(yīng)格式詳解
一、flask路由分模塊管理
1.1、使用藍(lán)圖
在flask中可以使用藍(lán)圖Blueprint來(lái)進(jìn)行創(chuàng)建路由進(jìn)行分模塊。 具體操作,我們可以在項(xiàng)目根目錄下創(chuàng)建一個(gè)controller文件夾來(lái)存儲(chǔ)分模塊的路由。
在controller文件夾里創(chuàng)建product_controller.py,在里面如下寫法引入藍(lán)圖,并且注冊(cè)藍(lán)圖:
from flask import Blueprint product_blue = Blueprint('product', __name__) # 定義藍(lán)圖路徑及請(qǐng)求方法和請(qǐng)求返回邏輯 @product_blue.route('/get', methods=['get', 'post']) def getproduct(): return 'product' @product_blue.route('/search', methods=['get', 'post']) def searchproduct(): return 'search'
那么我們?cè)陧?xiàng)目主邏輯文件main.py
中,去引入并注冊(cè)這個(gè)藍(lán)圖:
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()
接下來(lái)我們運(yùn)行程序,可以看到如下效果:
可以看到我們使用藍(lán)圖分模塊的創(chuàng)建已經(jīng)生效了,這樣如果模塊對(duì)的話,我們就方便管理了。不會(huì)造成代碼全部冗余在一個(gè)主文件中。
1.2、使用flask_restful
那么相比與藍(lán)圖Blueprint,flask_restful的優(yōu)勢(shì)就在于它能夠做更多的操作,比如參數(shù)的驗(yàn)證,返回直接字典就能解析成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()
現(xiàn)在已經(jīng)是restful形式的api了,我們采用apifox或者postman測(cè)試請(qǐng)求接口如下:
可以看到get請(qǐng)求成功,但是在post請(qǐng)求時(shí),我們沒有傳必傳參數(shù),所以出現(xiàn)了報(bào)錯(cuò)。我們嘗試將必傳參數(shù)加上:
那么可以看到將必傳的參數(shù)加上后,請(qǐng)求成功。 兩種模式可以共存,但是一般我們只用一種就行了。
相信細(xì)心的小伙伴已經(jīng)發(fā)現(xiàn),失敗和成功返回的數(shù)據(jù)格式不一樣,成功有code,失敗卻沒有code,那么我想自定義失敗返回的數(shù)據(jù)格式,將怎么操作呢,接下來(lái)自定義flask_restful的錯(cuò)誤響應(yīng)。
二、自定義flask_restful響應(yīng)格式
在根目錄下創(chuàng)建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)
我們將錯(cuò)誤狀態(tài)拎出來(lái)自定義返回格式。 在main.py
主文件中加入這兩行代碼:
from errors import custom_abort flask_restful.abort = custom_abort
效果如下:
可以看到我們成功的返回了相同的數(shù)據(jù)結(jié)構(gòu)。
以上就是flask路由分模塊管理及自定義restful響應(yīng)格式詳解的詳細(xì)內(nèi)容,更多關(guān)于flask路由管理restful響應(yīng)格式的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
python自動(dòng)化運(yùn)維之Telnetlib的具體使用
本文將結(jié)合實(shí)例代碼,介紹python自動(dòng)化運(yùn)維之Telnetlib的具體使用,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-06-06PyTorch模型創(chuàng)建與nn.Module構(gòu)建
這篇文章主要為大家介紹了PyTorch模型創(chuàng)建與nn.Module構(gòu)建示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-07-07Centos環(huán)境部署django項(xiàng)目的全過程(永久復(fù)用)
Django是一款針對(duì)Python環(huán)境的WEB開發(fā)框架,能夠幫助我們構(gòu)架快捷,下面這篇文章主要給大家介紹了關(guān)于Centos環(huán)境部署django項(xiàng)目的相關(guān)資料,需要的朋友可以參考下2022-10-10通過?for?循環(huán)比較?Python?與?Ruby?的編程區(qū)別
這篇文章主要介紹了通過?for?循環(huán)比較?Python?與?Ruby?的編程區(qū)別,Ruby?與?Python?之間的差異在很大程度上可通過for循環(huán)看出本質(zhì),下文詳細(xì)介紹需要的小伙伴可以參考一下2022-05-05pycharm遠(yuǎn)程連接docker容器的操作流程
這篇文章主要給大家介紹了pycharm遠(yuǎn)程連接docker容器的操作流程,文中通過代碼示例和圖文講解介紹的非常詳細(xì),具有一定的參考價(jià)值,需要的朋友可以參考下2023-08-08快速了解Python開發(fā)中的cookie及簡(jiǎn)單代碼示例
這篇文章主要介紹了快速了解Python開發(fā)中的cookie及簡(jiǎn)單代碼示例,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-01-01django框架cookie和session用法實(shí)例詳解
這篇文章主要介紹了django框架cookie和session用法,結(jié)合實(shí)例形式詳細(xì)分析了Django框架cookie和session的功能、原理、使用方法及相關(guān)操作注意事項(xiàng),需要的朋友可以參考下2019-12-12python?Copula?實(shí)現(xiàn)繪制散點(diǎn)模型
這篇文章主要介紹了python?Copula實(shí)現(xiàn)繪制散點(diǎn)模型,文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的朋友可以參考一下2022-07-07