软件测试学习笔记丨 Flask 框架 - 集成 Swagger 文档
本文转自测试人社区,原文链接:https://ceshiren.com/t/topic/23424
介绍
接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后,编写接口文档更是重中之重。但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口文档和实际情况不一致,接口文档不规范,不及时更新等问题。
Swagger 可以完美的解决上述问题, Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,它支持自动生成接口文档界面,支持在界面上测试 API 接口等功能
namespace(命名空间)的使用
复制代码
效果展示:
Swagger 接口文档配置
方式一:
使用 @api.doc()或者 @namespace.doc()装饰请求方法
复制代码
方式二【推荐】:
使用 parser = api.parser()配合 @api.expect(parser)或者 @namespace.expect(parser)装饰器实现入参的校验和传入
api.parser() :解析器
方法二当请求参数类型不匹配或出现其他问题时,会有明显的提示,比方法一更直观
required 是否为必填项
复制代码
常用的关键字参数
处理 get 请求,一般来说用 args,即 location=‘args’
处理 post 请求,一般来说用 json,file,form
choice 枚举类型的 location=‘args’
复制代码
注意:json 格式和 file 格式不能同时存在,也不能和 form 格式同时存在
软件测试开发免费视频教程分享
版权声明: 本文为 InfoQ 作者【测试人】的原创文章。
原文链接:【http://xie.infoq.cn/article/516ea60075c4433a909a329c0】。文章转载请联系作者。
评论