Apifox 开发流程操作手册

2024/12/27 开发工具

# 一、设计开发测试流程

  1. 前端(或后端)在 Apifox (opens new window) 上定好接口文档初稿。(新功能)

  2. 前后端 一起评审、完善接口文档,定好接口用例。(新功能)

  3. 前端 使用系统根据接口文档自动生成的 Mock 数据进入开发,无需手写 mock 规则,也无需等后端功能开发好,于后端一起并行开发该功能。(新功能)

  4. 后端 对已有标品接口变动时先一键上传至Apifox资产管理项目中。(已有功能)

  5. 后端 使用接口用例 调试开发中的接口,当所有接口用例调试通过,接口即开发完成。若开发过程中接口有改动,调试的时候会自动更新文档,零成本的保障了接口维护的及时性。

  6. 后端 每次调试完一个功能就保存为一个接口用例

  7. 测试人员 直接使用接口用例测试接口。

  8. 所有接口开发完成后,测试人员(也可以是后端)使用集合测试功能进行多接口集成测试,完整测试整个接口调用流程。

  9. 前后端 都开发完,前端从Mock 数据切换到正式数据,联调通常都会非常顺利,因为前后端双方都完全遵守了接口定义的规范。

# 步骤1:下载“Apifox 工具” 安装桌面端

下载安装地址点击这里 (opens new window)

# 步骤2:打开“Apifox 工具” 安装桌面端

1、用自己微信扫码登录。

2、让项目负责人发送邀请成员链接点击加入项目中。

# 步骤3:IDEA 安装 “Apifox Helper”插件

在 IntelliJ IDEA 的插件 Marketplace 内搜索 Apifox Helper 进行安装。 (opens new window)

在 IntelliJ IDEA 已安装得 “Apifox Helper”插件里配置 API 访问令牌。 (opens new window)

# 步骤4:接口文档上传

Controller 接口类同步上传生成接口文档 (opens new window)

# 步骤5:测试接口

1)接口前置自动init&后置自动断言: https://apifox.com/help/pre-post-processors-and-scripts/introduction (opens new window)

2)自动化场景测试: https://apifox.com/help/automated-testing/test-scenarios/creating-test-case (opens new window)

3)Mock 一键自动化模拟生成请求表单数据:https://apifox.com/help/api-mock/intro-to-mock (opens new window)