您好,登录后才能下订单哦!
这篇文章主要讲解了“怎么用flask生成swagger文档”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“怎么用flask生成swagger文档”吧!
安装flask-restplus 第三方包,使用pip install flask-restplus 安装即可。
在一个普通的正常的flask 应用项目结构下,应该是在extensions.py 下进行代码书写,因为这是进行程序扩展的代码编写处。导包,导入flask_restplus 下的Api,Resource,fields。获取一个app 实例。并进行namespace 的书写。代码如下:
api = Api(doc='/swagger') api.init_app(app, version='1.0', title='Data Visualization And Analysis API', description='A Charting and Data analysis API') bar_line = api.namespace('drawing bar and line', path='/', description="draw bar and line chart") pie = api.namespace('drawing pie', path='/', description="draw pie chart") radar = api.namespace('drawing radar', path='/', description="draw radar chart") scatter = api.namespace('drawing scatter', path='/', description="draw scatter chart") data_analysis = api.namespace('data analysis', path='/', description="data analysis")
获取一个实例化Api对象,app是一个实例化的flask对象,通过在实例化Api对象时通过doc 参数可以指定最终的接口文档通过什么路由可以访问到。api.namespace :是命名空间,很多接口都有get,post,命名空间把他们分隔开,可理解为蓝图。 path:代表他们的路由地址,这里让他们都使用route的地址,不写的话会把命名空间的name加到路由地址的最前面 description:是对该组下所有接口的总的一个注释。
通过api.model 来描述请求的request 和 响应的response,通过api.namespace.parser 来描述请求的headers 参数。
代码示例如下:
# 使用parser 来描述接口的headers 和 query bar_line_parameter = bar_line.parser() bar_line_parameter.add_argument('Authorization', location='headers', default="a") bar_line_parameter.add_argument('User-Agent', location='headers', default="ua") # 使用model 来描述接口的请求体 bar_line_model = api.model('Bar_Line_Request', { "type": fields.String(default="bar"), "title": DictItem(required=True, default={}, description="chart title option"), "item": DictItem(required=True, default={}, description="chart series item option"), "xaxis": DictItem(required=True, default={}, description="chart xaxis option"), "yaxis": DictItem(required=True, default={}, description="chart yaxis option"), "grid": DictItem(required=True, default={}, description="chart grid option"), "legend": DictItem(required=True, default={}, description="chart legend option"), "tooltip": DictItem(required=True, default={}, description="chart tooltip option"), "background": DictItem(required=True, default={}, description="chart tooltip option"), }, description="request api needed body parameter") # 使用model 来描述接口的响应 bar_line_response = api.model('bar_line_Response', { 'data': DictItem(required=True, default=bar_line_response_data_default, description="chart option"), 'status': fields.Integer(required=True, default=200, description="response status"), 'msg': fields.String(required=True, default="successful", description="api response message") })
如上,其中bar_line 是api.namespace() 的返回对象,使用parser 的add_argument() 方法来添加headers ,或query 中请求所需参数,同时可以定义默认值。 使用model 来描述请求的请求体,响应也是。model 需要指定一个唯一的key 值,和一个 {} 字典键值对,在该字典键值对中key值是所需传输的name,value 是通过flask-restplus 下的fields 来指定数据类型以及默认值描述 的值。 如果fields中提供的数据类型满足不了使用,可以通过自定义类继承fields.Row ,并且实现format 方法,来使用自定义的数据类型。代码中的DictItem 就是自定义数据类型。
将以上定义的model,parser 应用到接口上。通过装饰器的方式,代码如下。
# 使用api.namespace.route 来指定接口的访问路由,使用description来描述接口 @bar_line.route('/api/chart/draw/bar_and_line', doc={"description": "返回图表的echarts 配置项信息,当请求参数配置为空时返回默认配置的图表即示例样例,否则根据请求的配置参数返回对应的完整的图表配置信息"}) # 这里的api.namespace.expect 需要与上面的api.namespace.expect 联用 @bar_line.expect(bar_line_parameter) # 需要继承于Resource类 class BarLineOption(Resource): # doc 用于描述接口,body=X 指定请求的body描述 @bar_line.doc('Return to bar and line chart configuration item') @bar_line.doc(body=bar_line_model) # marshal_with 指定响应的描述 @bar_line.marshal_with(bar_line_response) # 接口支持什么方法,就定义一个什么方法。 def post(self): return {'data': {}, "status": 200, "msg": "successful"}
感谢各位的阅读,以上就是“怎么用flask生成swagger文档”的内容了,经过本文的学习后,相信大家对怎么用flask生成swagger文档这一问题有了更深刻的体会,具体使用情况还需要大家实践验证。这里是亿速云,小编将为大家推送更多相关知识点的文章,欢迎关注!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。