flask項(xiàng)目集成swagger的方法
此次主要介紹介紹在flask框架中如何集成swagger文檔， 我們知道以前給同事提供接口文檔主要是寫(xiě)一個(gè)文檔， 當(dāng)遇到頻繁修改時(shí)，就需要更新文檔非常麻煩， 這時(shí)swagger文檔就出現(xiàn)了，一個(gè)在線得接口文檔，同事可以在線上查看接口文檔， 當(dāng)需要修改接口時(shí)秩序修改對(duì)應(yīng)得代碼，文檔也會(huì)隨之更新。如下圖所示。
此次集成參考flask-restplus官方文檔，flask-restplus框架是flask-restful框架的一個(gè)加強(qiáng)版， 類(lèi)似django框架的rest framework框架，應(yīng)用前得先安裝框架執(zhí)行命令：
pip install flask-restplus
然后結(jié)合官網(wǎng)寫(xiě)個(gè)簡(jiǎn)單示例感受一下：
from flask import Flask
from flask_restplus import Api, Resource, fields, reqparse
app = Flask(__name__)
api = Api(app, version='1.0', title='TodoMVC API', description='A simple TodoMVC API',)
ns = api.namespace('todo', description='TODO operations') # 模塊命名空間
todo = api.model('Todo', { # 返回值模型
'id': fields.Integer(readonly=True, description='The task unique identifier'),
'task': fields.String(required=True, description='The task details')
})
parser = reqparse.RequestParser() # 參數(shù)模型
parser.add_argument('id', type=str, required=True, help="id")
parser.add_argument('name', type=str, required=True, help="名稱")
parser.add_argument('volume', type=int, required=True, help="方量")
class TodoDAO(Resource):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.params = parser.parse_args()
@ns.expect(parser) # 用于解析對(duì)應(yīng)文檔參數(shù)，
@ns.response(200, "success response", todo) # 對(duì)應(yīng)解析文檔返回值
def get(self):
return self.params
ns.add_resource(TodoDAO, "/to", endpoint="to_do")
app.run()
我們啟動(dòng)得地址為127.0.0.1:5000得地址， 然后我們只需在瀏覽器打開(kāi)即可查看自己寫(xiě)好得api文檔，如下圖：
好了，至此我們已經(jīng)集成好了swagger文檔， 需要更詳細(xì)得內(nèi)容可以參考官網(wǎng)文檔， 比方更改文檔地址等。
以上就是flask項(xiàng)目集成swagger的方法的詳細(xì)內(nèi)容，更多關(guān)于flask項(xiàng)目集成swagger的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Python 實(shí)現(xiàn)簡(jiǎn)單的shell sed替換功能(實(shí)例講解)
下面小編就為大家?guī)?lái)一篇Python 實(shí)現(xiàn)簡(jiǎn)單的shell sed替換功能(實(shí)例講解)。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-09-09
python使用matplotlib繪圖時(shí)圖例顯示問(wèn)題的解決
matplotlib 是python最著名的繪圖庫(kù)，它提供了一整套和matlab相似的命令A(yù)PI，十分適合交互式地進(jìn)行制圖。下面這篇文章主要給大家介紹了在python使用matplotlib繪圖時(shí)圖例顯示問(wèn)題的解決方法，需要的朋友可以參考學(xué)習(xí)，下面來(lái)一起看看吧。2017-04-04
Python使用回溯法子集樹(shù)模板解決迷宮問(wèn)題示例
這篇文章主要介紹了Python使用回溯法解決迷宮問(wèn)題,簡(jiǎn)單講述了迷宮問(wèn)題的原理并結(jié)合實(shí)例形式分析了Python基于回溯法子集樹(shù)模板解決迷宮問(wèn)題的相關(guān)操作技巧與注意事項(xiàng),需要的朋友可以參考下2017-09-09
所有編程語(yǔ)言在編寫(xiě)時(shí)都要遵守語(yǔ)音結(jié)構(gòu)和流程控制，他們控制了整個(gè)程序的運(yùn)行步驟。流程控制包括順序控制、條件控制和循環(huán)控制2022-07-07
這篇文章主要介紹了Python中求對(duì)數(shù)方法總結(jié)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03
Django壓縮靜態(tài)文件的實(shí)現(xiàn)方法詳析
最近在學(xué)習(xí)Django配置靜態(tài)文件，下面這篇文章主要給大家介紹了關(guān)于Django壓縮靜態(tài)文件的實(shí)現(xiàn)方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，需要的朋友可以參考借鑒，下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2018-08-08
Python?encode()方法和decode()方法詳解
encode() 方法為字符串類(lèi)型（str）提供的方法，用于將 str 類(lèi)型轉(zhuǎn)換成 bytes 類(lèi)型，這個(gè)過(guò)程也稱為“編碼”，這篇文章主要介紹了Python?encode()方法和decode()方法,需要的朋友可以參考下2022-12-12
python一行代碼就能實(shí)現(xiàn)數(shù)據(jù)分析的pandas-profiling庫(kù)
這篇文章主要為大家介紹了python一行代碼就能實(shí)現(xiàn)數(shù)據(jù)分析的pandas-profiling庫(kù),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01
python開(kāi)啟攝像頭以及深度學(xué)習(xí)實(shí)現(xiàn)目標(biāo)檢測(cè)方法
今天小編就為大家分享一篇python開(kāi)啟攝像頭以及深度學(xué)習(xí)實(shí)現(xiàn)目標(biāo)檢測(cè)方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-08-08
Python實(shí)現(xiàn)的質(zhì)因式分解算法示例
這篇文章主要介紹了Python實(shí)現(xiàn)的質(zhì)因式分解算法,涉及Python數(shù)學(xué)運(yùn)算相關(guān)操作技巧,需要的朋友可以參考下2018-05-05