告别繁琐，Apifox让API开发、测试更轻松！Apifox = Postman + Swagger + Mock + JMeter API 设计、开发、测试一体化协作平台

汀丶人工智能

发布于 2024-06-06 08:42:37

4630

发布于 2024-06-06 08:42:37

文章被收录于专栏：NLP/KG

从Postman到Apifox，为什么开发者都在转投它的怀抱？

一、Apifox简介

1.1 为什么要使用 Apifox 工具

Apifox 是集 API 文档、API 调试、API Mock、API 自动化测试多项实用功能为一体的 API 管理平台，定位为 Postman + Swagger + Mock + JMeter。旨在通过一套系统、一份数据，解决多个工具之间的数据同步问题。只需在 Apifox 中定义 API 文档；API 调试、API 数据 Mock、API 自动化测试等功能就可以直接使用，无需再次定义。API 文档和 API 开发调试流程在同一个工具内闭环，API 调试完成后即可确保与 API 文档定义完全一致。高效、及时、准确！

可以看到整个开发过程都是围绕 API 开展的，在这个过程中不同团队都需要对接口的定义进行操作，这会导致在联调时极易出现定义不一致等诸多问题。而且还用到了不同的工具如 Swagger、Postman、Mock、JMeter，明显造成了很多资源的浪费和低效使用。

而 Apifox 的诞生正是为了解决以上问题，Apifox 的研发宗旨—— 节省研发团队的每一分钟。

参考链接：https://apifox.com/compare/postman-vs-apifox/

1.2. Apifox 有哪些功能

针对以上问题，Apifox 也确实提出了实际的解决方案，在 Apifox 官网中展示着这么一句话 Apifox = Postman + Swagger + Mock + JMeter，也就是将这四个开发工具的核心功能综合到了一起，使得前端、后端、测试均可方便定义和使用 API，避免工作的大量重复，最重要的是关于 API 的任何调整都可以实时同步到各个团队，保证项目过程中各个环节的一致性。

除此之外，Apifox 还具有以下丰富的功能：

API 文档：可视化的接口文档管理，支持数据结构定义，多接口复用相同数据结构，接口文档遵循 OpenAPI 规范，支持接口文档在线分享。
API 调试：拥有 Postman 的所有功能，更好用，可自动校验数据结构，自动发现接口异常。
API 自动化测试：完善的接口场景测试功能，支持调用其他编程语言。
API 数据 Mock：零配置即可 Mock 出非常人性化的数据，内置 mock.js 规则引擎，支持自定义期望。
CI 持续集成：支持命令行方式运行接口测试，支持集成 Jenkins 等持续集成工具。
数据库操作：支持数据库的读取与接口校验。
自动生成代码。
数据导入 / 导出：支持导入 / 导出十多种数据格式。
团队协作。
…

更多详细功能请参见 Apifox 官网 www.apifox.cn。

1.3. API First 理念下的开发流程

Apifox 秉承的是 API first(API 优先) 的先进理念，也就是开发团队首先制定 API，然后围绕 API 展开设计和开发。使用 Apifox 之后，开发效率会大大提升且各方工作体验更好，与外部团队的协作也会更加顺畅。在此理念下的开发流程是这样的：

开发阶段	工作任务
设计阶段	根据需求文档确定接口设计思路，接口设计者设计好接口初稿，然后前后端一起评审接口，完善接口文档。
开发阶段	前端：Apifox 会根据接口文档自动生成 Mock 数据，直接进入开发过程无需手写 Mock 规则。后端：使用 Apifox 根据接口定义调试接口，即使在开发过程中接口有变化，调试时修改接口定义就可以自动更新文档。测试：使用后端调试时保存的接口用例生成测试用例。
联调和测试阶段	此时所有接口开发完成，测试 / 后端使用集合测试功能进行多借口集成测试。

Apifox 是接口管理、开发、测试全流程集成工具，使用受众为整个研发技术团队，主要使用者为前端开发、后端开发和测试人员。

前端开发

- 接口文档管理
- 接口数据 Mock
- 接口调试
- 前端代码自动生成

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

- 接口调试
- 接口自动化测试

1.4 最佳实践

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

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

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

- **接口设计**：即 **新建接口** 界面或接口详情里的 **编辑** 界面，用途是 **定义接口文档规范**，而不是 **运行** 接口，所以该界面是只能定义接口基本信息、`参数名`及参数说明等，而不能设置`参数值`。**参数值**、**前置脚本 / 后置脚本** 等信息请在`接口运行`界面或`接口用例`界面填写。
- **接口运行**：即接口详情里的 **运行** 界面，用途是 **临时调试接口**，**运行** 完后，需要点击`保存为用例`，才能将填写的 **参数值**、**前置脚本 / 后置脚本** 等信息保存下来；否则关闭 tab 后，这些信息将会丢失。