当前位置 博文首页 > flask项目集成swagger的方法
此次主要介绍介绍在flask框架中如何集成swagger文档， 我们知道以前给同事提供接口文档主要是写一个文档， 当遇到频繁修改时，就需要更新文档非常麻烦， 这时swagger文档就出现了，一个在线得接口文档，同事可以在线上查看接口文档， 当需要修改接口时秩序修改对应得代码，文档也会随之更新。如下图所示。
此次集成参考flask-restplus官方文档，flask-restplus框架是flask-restful框架的一个加强版， 类似django框架的rest framework框架，应用前得先安装框架执行命令：
pip install flask-restplus
然后结合官网写个简单示例感受一下：
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() # 参数模型
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) # 用于解析对应文档参数，
@ns.response(200, "success response", todo) # 对应解析文档返回值
def get(self):
return self.params
ns.add_resource(TodoDAO, "/to", endpoint="to_do")
app.run()
我们启动得地址为127.0.0.1:5000得地址， 然后我们只需在浏览器打开即可查看自己写好得api文档，如下图：
好了，至此我们已经集成好了swagger文档， 需要更详细得内容可以参考官网文档， 比方更改文档地址等。
jsjbwy