文章目录
一、Apifox简介
1. Apifox是什么?
1、Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,
2、定位:Postman + Swagger + Mock + JMeter。
通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好 API 文档,API 调试、API 数据 Mock、API 自动化测试就可以直接使用,无需再次定义;API 文档和 API 开发调试使用同一个工具,API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确
2. Apifox能解决什么?
1. 后端、前端、测试团队可以同步开始工作,而不需要互相等待;
2. 使用基于API的自动Mock、代码自动生成和自动化测试工具,大幅提升开发效率;开发的各个角色都会获得更好的工作体验;
3. API可以在不同的项目中重复使用,提高开发效率;
4. 新人更容易熟悉项目,方便团队规模的扩大;
5. 与外部团队的协作也更加顺畅。
3. 下载安装
官网下载地址:http://apifox.cn/a1csdnwx,分为桌面版和WEB版
自行一键式安装即可!
二、使用Apifox团队开发流程
1. 设计阶段
根据需求文档讨论确定接设计思路。
接口设计者在Apifox上定好接口文档初稿。
接口评审环节,前后端起评审、 完善接口文档,定好接用例。
2. 开发阶段
前端:Apifox 会根据接口文档自动生成Mock数据,直接可以进入开发,无需手写mock规则。
后端:
- 使用Apifox直接根据接口定义来调试接口,每次调试一 个功能就保存一 个接口用例,方便自己反复调试。
- 如果开发过程中接口有变化,调试的时候修改接定义就自动更新了文档,零成本地保障了接口维护的及时性。
测试:直接使用后端调试时保存的接口用例生成测试用例。
3. 联调和测试阶段
所有接口开发完成后,测试人员(也可以是后端)使用集合测试功能进行多接口集成测试,完整测试整个接口调用流程。
前后端都开发完,前端从Mock数据切换到正式数据,联调通常都会非常顺利,因为联调过程中最经常出现的问题就是前后端双方的数据定义不一致,而使用Apifox进行开发保证了所有人都完全遵守接口定义的规范,以前存在的很多令人头大的问题就不存在了。
测试可以使用测试套件进行自动化回归测试和性能测试。
二、apifox页面布局简介
1. 新建团队
1. apifox支持团队协同办公,可以根据需求创建不同的团队,在工具页面左侧,显示自己的团队,也可新建团队:
2. 新建团队需要取一个名称:
3. 创建成功团队后,可以邀请成员、设置权限等,或删除团队:
2. 新建项目
在团队项目右上角可以新建一个项目,如下图:
分为私有项目和共公开项目:
3. 体验案例项目
还不会操作流程的可以去体验下Apifox准备的案例项目,并且还有配套操作视频
4. 新建接口
1. 当输入:/user/{id}
参数时会发现下面的Path
参数就直接进入了
2. 设置返回值
我这边选择的JSON数据智能导入
{
"code":"0",
"data":{
"id":"1",
"username":"xiaoming"
}
}
3. 定义返回示例:
4. 点击保存完成
5. 运行接口
运行界面 -》发送
6. 分享文档
1. 点击项目概览,新建分享
2. 可以选择分享对象,是否需要密码,过期时间,分享接口范围等
3.
7. 导入数据
项目管理 -》 导入数据 -》支持多种数据格式导入
8. 导出数据
支持直接导出 OpenAPI (原Swagger)、HTML、Markdown
等数据格式。
三、体验总结
介绍了Apifox这么多实用的功能,软件完全免费,堪称国产良心,有兴趣的小伙伴上手体验一番!