本文转自测试人社区，原文链接：https://ceshiren.com/t/topic/23424
- 接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后，编写接口文档更是重中之重。但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致，接口文档不规范，不及时更新等问题。
- Swagger 可以完美的解决上述问题， Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务，它支持自动生成接口文档界面，支持在界面上测试API接口等功能
效果展示：
方式一：
使用@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格式同时存在
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/150612.html