apifox

关键字

• apifox
• postman
• jmeter
• 接口文档

是什么？

官网

官方说明

• API 文档、API 调试、API Mock、API 自动化测试
• API 一体化协作平台
• 更先进的 API 设计/开发/测试工具
• Apifox = Postman + Swagger + Mock + JMeter

使用

步骤

• 需要注册一个账号，免费
• 需要编写一个暴露swagger接口文档的服务A （搜索springboot-sample-swagger3）
• 启动服务A
• 访问swagger接口 http://localhost:port/v3/api-docs
• 去apifox中的个人空间下创建一个项目，名称为 springboot-sample-swagger3
• 进入项目 –> 项目设置 –> 数据管理 –> 导入数据（手动导入）
  • 选OpenAPI/Swagger、URL导入，填写的url为http://localhost:60001/v3/api-docs，会有同步结果
• 也可以考虑导入数据（自动同步）

优化配置

• 每个Controller会对应apifox中的一个目录，目录名为 @Api的tags值，tags值可以是”aaaa/bbb/ccc”会自动创建目录
  • Controller中的每个方法有 @ApiOperation，接口名称是value值，也可以使用tags创建目录（但不建议）
• 配置固定值，见R#code只返回200