前言

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位 Postman + Swagger + Mock + JMeter。通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好 API 文档，API 调试、API 数据 Mock、API 自动化测试就可以直接使用，无需再次定义；API 文档和 API 开发调试使用同一个工具，API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确

最佳实践

• 前端（或后端）在 Apifox 上定好接口文档初稿。
• 前后端 一起评审、完善接口文档，定好接口用例。
• 前端 使用系统根据接口文档自动生成的 Mock 数据进入开发，无需手写 mock 规则。
• 后端 使用接口用例调试开发中接口，只要所有接口用例调试通过，接口就开发完成了。如开发过中接口有变化，调试的时候就自动更新了文档，零成本的保障了接口维护的及时性。
• 后端 每次调试完一个功能就保存为一个接口用例。
• 测试人员 直接使用接口用例测试接口。
• 所有接口开发完成后，测试人员（也可以是后端）使用集合测试功能进行多接口集成测试，完整测试整个接口调用流程。
• 前后端 都开发完，前端从Mock 数据切换到正式数据，联调通常都会非常顺利，因为前后端双方都完全遵守了接口定义的规范。

基本概念

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

界面概览

Apifox和Apipost选择可以看这

Apifox和Apipost有什么区别？到底谁更牛？

官方文档

Apifox 使用文档