快速上手

• 前端开发

  • 接口文档管理
  • 接口数据 Mock
  • 接口调试

• 后端开发

  • 接口文档管理
  • 接口调试
  • 接口自动化测试
  • 后端代码自动生成
• • 接口调试
  • 接口自动化测试

1. 前端（或后端）在 Apifox 上定好接口文档初稿。
2. 前后端 一起评审、完善接口文档，定好接口用例。
3. 前端 使用系统根据接口文档自动生成的 Mock 数据进入开发，无需手写 mock 规则。
4. 后端 每次调试完一个功能就保存为一个接口用例。
5. 测试人员 直接使用接口用例测试接口。
6. 所有接口开发完成后，测试人员（也可以是后端）使用集合测试功能进行多接口集成测试，完整测试整个接口调用流程。
7. 前后端 都开发完，前端从Mock 数据切换到，联调通常都会非常顺利，因为前后端双方都完全遵守了接口定义的规范。

1. 接口设计：定义接口规范（如接口路径、参数、返回值、数据结构等），也就是编写接口文档。
2. 接口运行：输入特定的接口参数，然后运行，主要用来调试接口。接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数，非常方便。
3. 接口用例：通常一个接口会有多种情况用例，比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性，用接口用例来调试接口非常高效。
4. 数据模型：可复用的数据结构，定义接口返回数据结构及请求参数数据结构（仅 JSON 和 XML 模式）时可直接引用。
5. 集合测试：多接口集成测试，主要有功能测试、性能测试、。
6. 快捷请求：类似 Postman 的接口调试方式，主要用途为临时调试一些无需文档化的接口，无需提前定义接口即可快速调试。
7. 代码生成：根据接口及数据数据模型定义，系统自动生成接口请求代码、前端业务代码及后端业务代码。

新人注意

和 Postman 不一样，Apifox 是区分接口设计和接口运行两个概念的。

• 接口运行：即接口详情里的 运行 界面，用途是 临时调试接口，运行 完后，需要点击保存为用例，才能将填写的 参数值、前置脚本/后置脚本 等信息保存下来；否则关闭 tab 后，这些信息将会丢失。

接口概览页

接口设计界面

接口运行界面