flask項目集成swagger的方法
更新時間：2020年12月09日 16:02:47 作者：種樹飛
這篇文章主要介紹了flask項目集成swagger的方法，幫助大家更好的理解和使用flask框架，感興趣的朋友可以了解下
此次主要介紹介紹在flask框架中如何集成swagger文檔， 我們知道以前給同事提供接口文檔主要是寫一個文檔， 當(dāng)遇到頻繁修改時，就需要更新文檔非常麻煩， 這時swagger文檔就出現(xiàn)了，一個在線得接口文檔，同事可以在線上查看接口文檔， 當(dāng)需要修改接口時秩序修改對應(yīng)得代碼，文檔也會隨之更新。如下圖所示。
此次集成參考flask-restplus官方文檔，flask-restplus框架是flask-restful框架的一個加強版， 類似django框架的rest framework框架，應(yīng)用前得先安裝框架執(zhí)行命令：
pip install flask-restplus
然后結(jié)合官網(wǎng)寫個簡單示例感受一下：
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) # 用于解析對應(yīng)文檔參數(shù)，
@ns.response(200, "success response", todo) # 對應(yīng)解析文檔返回值
def get(self):
return self.params
ns.add_resource(TodoDAO, "/to", endpoint="to_do")
app.run()
我們啟動得地址為127.0.0.1:5000得地址， 然后我們只需在瀏覽器打開即可查看自己寫好得api文檔，如下圖：
好了，至此我們已經(jīng)集成好了swagger文檔， 需要更詳細(xì)得內(nèi)容可以參考官網(wǎng)文檔， 比方更改文檔地址等。
以上就是flask項目集成swagger的方法的詳細(xì)內(nèi)容，更多關(guān)于flask項目集成swagger的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
大家好，本篇文章主要講的是Python裝飾器中@property使用詳解，感興趣的同學(xué)趕快來看一看吧，對你有幫助的話記得收藏一下2022-01-01
Pygame實戰(zhàn)之實現(xiàn)經(jīng)典外星人游戲
這篇文章主要介紹了通過Pygame實現(xiàn)經(jīng)典的外星人游戲的示例代碼，文中的代碼講解詳細(xì)，對我們了解Pygame有一定的幫助，感興趣的同學(xué)可以試一試
2022-01-01 
Python使用Pandas庫實現(xiàn)MySQL數(shù)據(jù)庫讀寫
本次分享將介紹如何在Python中使用Pandas庫實現(xiàn)MySQL數(shù)據(jù)庫的讀寫,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
2023-08-08 
這篇文章主要為大家詳細(xì)介紹了Python?flask的前后端交互，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助
2022-03-03 
keras的backend 設(shè)置 tensorflow,theano操作
這篇文章主要介紹了keras的backend 設(shè)置 tensorflow,theano操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-06-06 
這篇文章主要介紹了Sublime Text v4.0(4143)安裝破解方法，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
2023-02-02 
Keras自定義實現(xiàn)帶masking的meanpooling層方式
這篇文章主要介紹了Keras自定義實現(xiàn)帶masking的meanpooling層方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-06-06 
這篇文章主要介紹了用Pygal繪制直方圖代碼示例，具有一定借鑒價值，需要的朋友可以了解下。
2017-12-12 
這篇文章主要介紹了vue常用指令代碼實例,需要的朋友可以參考下
2020-03-03