flask项目集成swagger的方法
程序员文章站
2022-06-24 09:58:17
此次主要介绍介绍在flask框架中如何集成swagger文档, 我们知道以前给同事提供接口文档主要是写一个文档, 当遇到频繁修改时,就需要更新文档非常麻烦, 这时swagger文档就出现了,一个在线得...
此次主要介绍介绍在flask框架中如何集成swagger文档, 我们知道以前给同事提供接口文档主要是写一个文档, 当遇到频繁修改时,就需要更新文档非常麻烦, 这时swagger文档就出现了,一个在线得接口文档,同事可以在线上查看接口文档, 当需要修改接口时秩序修改对应得代码,文档也会随之更新。如下图所示。
此次集成参考,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文档, 需要更详细得内容可以参考官网文档, 比方更改文档地址等。
以上就是flask项目集成swagger的方法的详细内容,更多关于flask项目集成swagger的资料请关注其它相关文章!
上一篇: C语言实现一个简单的扫雷游戏