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文档, 需要更详细得内容可以参考官网文档, 比方更改文档地址等。
以上就是flask项目集成swagger的方法的详细内容,更多关于flask项目集成swagger的资料请关注脚本之家其它相关文章!
相关文章
Python 实现简单的shell sed替换功能(实例讲解)
下面小编就为大家带来一篇Python 实现简单的shell sed替换功能(实例讲解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧2017-09-09python使用matplotlib绘图时图例显示问题的解决
matplotlib 是python最著名的绘图库,它提供了一整套和matlab相似的命令API,十分适合交互式地进行制图。下面这篇文章主要给大家介绍了在python使用matplotlib绘图时图例显示问题的解决方法,需要的朋友可以参考学习,下面来一起看看吧。2017-04-04Python encode()方法和decode()方法详解
encode() 方法为字符串类型(str)提供的方法,用于将 str 类型转换成 bytes 类型,这个过程也称为“编码”,这篇文章主要介绍了Python encode()方法和decode()方法,需要的朋友可以参考下2022-12-12python一行代码就能实现数据分析的pandas-profiling库
这篇文章主要为大家介绍了python一行代码就能实现数据分析的pandas-profiling库,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2024-01-01
最新评论