flask項(xiàng)目集成swagger的方法

更新時(shí)間：2020年12月09日 16:02:47 作者：種樹(shù)飛

這篇文章主要介紹了flask項(xiàng)目集成swagger的方法，幫助大家更好的理解和使用flask框架，感興趣的朋友可以了解下

　　此次主要介紹介紹在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="名稱(chēng)")
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文檔，如下圖：