Apifox 是什么
Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,定位 Postman Swagger Mock JMeter。
Apifox 在哪里使用
Apifox 使用在全团队协作里面,大家共一份文档,协同办公。
为什么使用 Apifox
Apifox 优点如下:
- 一套系统、一份数据,解决多个系统之间的数据同步问题;
- 只要定义好 API 文档,API 调试、API 数据 Mock、API 自动化测试就可以直接使用,无需再次定义;
- API 文档和 API 开发调试使用同一个工具,API 调试完成后即可保证和 API 文档定义完全一致;
- 高效、及时、准确。
如何落地实施
今天的分享以 java 项目集成为示例来演示。
1.如何部署?
目前部署有两种方式:
- 基于 B/S 结构的 WEB 版
- 基于 C/S 结构的桌面版
两者可以协同,如下图所示。
桌面版:
WEB版:
2.如何协同?
项目、团队成员权限管理如下图所示:
后端同学:
Step1: 项目中引入 swagger 包
在项目里面引入 swagger 包后,在代码里面按照注解方式对 api 内容进行描述,尽可能的详细且实时同步更新 api 的变更。
问:在 apifox 平台里面如何导入api信息
答:
1.登录 Apifox 平台
2.目录路径: 项目设置
3.导入数据界面如下
Step2: Apifox 平台查看上面导入的接口数据
如下图所示:
Step3:【接口管理】下,选择一个接口进行调试与自测接口
Step4:【接口管理】下,选择一个接口运行后,执行保存
Step5: 提取响应结果里面的变量,用于给到下一个接口使用
Step6: 自动生成【业务代码】和【接口请求代码】
前端同学:
注意事项:请求环境要切换到 Mock 服务下。
Step1: 添加自定义接口
Step2: 调试自定义接口
Step3: 接口数据 Mock
测试同学:
Step1: 测试同学可以在 Apifox 平台上面对接口进行测试,只需要做一些简单的配置即可。
1.配置接口参数及header信息
2.添加断言
3.发送请求及检查响应
点击【发送】按钮
Step2: 测试同学针对接口编写接口用例并保存
Step3: 测试同学可以将上一步骤中添加的接口用例关联到一个用例组里面,然后一并执行且可以出测试报告
如下所示:
Step4: 测试套件功能可以将测试用例的做成集合,每个测试套件包含多个测试用例
Step5: 实现了简单的压测操作
总结
1. Apifox 可以很好的满足我们内部的使用。
2. Apifox 是云端管理接口,是会有一定的安全风险,如果想私有化,需要付费使用。