flask项目集成swagger的方法
作者:种树飞 时间:2022-08-04 09:00:48
此次主要介绍介绍在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文档, 需要更详细得内容可以参考官网文档, 比方更改文档地址等。
来源:https://www.cnblogs.com/lifei01/p/13797889.html
标签:flask,集成,swagger
![](/images/zang.png)
![](/images/jiucuo.png)
猜你喜欢
python pillow模块使用方法详解
2021-12-30 14:55:34
python+opencv打开摄像头,保存视频、拍照功能的实现方法
2021-06-12 15:16:02
Python3 模块、包调用&路径详解
2021-06-04 06:03:08
Python如何爬取qq音乐歌词到本地
2021-03-25 19:59:45
![](https://img.aspxhome.com/file/2023/8/97238_0s.jpg)
asp 数组 重复删除函数代码
2011-03-03 10:47:00
修改 CentOS 6.x 上默认Python的方法
2023-08-07 10:02:59
三谈Iframe自适应高度
2010-08-03 13:04:00
Python FTP操作类代码分享
2022-09-07 17:59:23
详解pandas中MultiIndex和对象实际索引不一致问题
2021-07-10 20:43:27
Go流程控制代码详解
2023-09-01 10:21:12
word-wrap同word-break的区别
2007-10-24 20:08:00
在ironpython中利用装饰器执行SQL操作的例子
2022-07-10 19:27:37
python Matplotlib数据可视化(2):详解三大容器对象与常用设置
2022-11-23 21:10:41
![](https://img.aspxhome.com/file/2023/2/70822_0s.png)
ASP MSSQL存储过程的实现小例
2011-04-06 11:02:00
Python matplotlib画图时图例说明(legend)放到图像外侧详解
2021-03-05 13:42:45
![](https://img.aspxhome.com/file/2023/4/78514_0s.jpg)
python 实现客户端与服务端的通信
2023-11-19 01:28:33
![](https://img.aspxhome.com/file/2023/7/101207_0s.png)
Python编写memcached启动脚本代码实例
2023-02-13 19:59:51
Python爬虫实现热门电影信息采集
2023-02-08 22:51:28
![](https://img.aspxhome.com/file/2023/2/118522_0s.jpg)
python list count统计个数的实现
2022-11-08 06:51:24
Tensorflow全局设置可见GPU编号操作
2021-04-21 12:41:46