Apifox超好用的接口管理神器

1、接口管理现状

1. 使用 Swagger 管理 API 文档
2. 使用 Postman 调试 API
3. 使用 mockjs 等工具 Mock API 数据
4. 使用 JMeter 做 API 自动化测试

维护不同工具之间数据一致性非常困难、低效。

2、Apifox 介绍

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位 Postman + Swagger + Mock + JMeter。通过一套系统、一份数据，解决多个系统之间的数据同步问题。

官网地址：https://www.apifox.cn/，除了应用程序还有web版

Apifox 解决方案：

1.后端（或前端）：在 Apifox 上定好接口文档初稿。

2.前后端：一起评审、完善接口文档，定好接口用例。

3.前端：使用系统根据接口文档自动生成的 Mock 数据进入开发，无需手写 mock 规则。

4.后端：使用接口用例 调试开发中接口，只要所有接口用例调试通过，接口就开发完成了。如开发过中接口有变化，调试的时候就自动更新了文档，零成本的保障了接口维护的及时性。

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

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

7.前后端 都开发完，前端从Mock 数据切换到正式数据

3、接口设计

接口设计即定义接口文档规范（如接口路径、参数、返回值、数据结构等）。可视化文档管理，高效便捷，零学习成本! 遵循业界的 OpenApi 3.0 (原 Swagger)、JSON Schema 规范。

3.1、环境管理

为方便在不同的环境，比如开发环境、测试环境、生产环境中设置不同的前置 URL、接口参数。只需在不同的环境设置不同的前置 URL 及参数，在不同环境中测试时，直接切换环境即可。

3.2、前置操作/后置操作

1、后置操作支持添加断言，可对接口返回的数据（或响应时间）设置断言，判断是否符合预期。可用于接口测试。

2、支持添加提取变量，可从接口返回结果里提取数据，设置到变量，方便其他接口运行的时候直接使用。

3.3、数据结构

数据结构和编程语言里的数据结构类似，主要使用在接口设计的接口响应Body 参数中。

可以添加可复用的数据结构（数据模型），然后在数据结构中引用；或者点击高级设置编辑源码，可以直接复制到其他接口，减少编写文档的时间

3.4、变量

和编程语言类似，变量是允许在多个地方重复使用的值。双大括号包裹变量名，如{{token}}，在请求参数、前置/后置操作中都可以使用变量。

1、环境变量：同一个变量可以在不同的环境设置不同的值，变量值会跟随环境切换而改变。

2、全局变量：全局变量不会跟随环境切换而改变。

3、临时变量：仅在单次运行接口用例或测试管理里的测试用例中有效，不会持久化保存。

4、接口调试

这个基本就是 Postman 有的功能，Apifox 上都有。输入特定的接口参数，然后运行，主要用来调试接口。

4.1、接口用例

接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数。

5、MOCK数据

内置 Mock.js 规则引擎，可以根据接口/数据结构定义、Mock规则配置、Mock 期望配置，自动生成模拟数据，也可以自定义Mock规则。

前后端可以同步进入开发，后端接口出来之前，前端可以通过 Mock 功能来制造假数据接口来进行开发和调试。

6、接口测试

提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。这个基本就是 JMeter 有的功能，Apifox 上都有。

1、支持使用测试数据

2、多线程支持性能测试

3、有详细的测试报告

7、其他

7.1、导入

支持多种数据格式，并且可以自动同步指定 URL 的数据源。

7.2、导出

支持将数据导出为 OpenApi (Swagger)、Markdown、Html 等数据格式。

7.3、快速调试

类似Postman的功能，临时需要调试某个接口，而不需要保存为文档或者用例。

7.4、在线文档

Apifox 项目可“在线分享” API 文档，分享出去的 API 文档可设置为公开或需要密码访问，非常方便与外部团队协作。