使用ApiFox衔接前后端开发人员，提升沟通效率实践

Apifox = Postman + Swagger + Mock + JMeter

Apifox是广州睿狐科技有限公司主办的信息服务系统网站，主要服务有API 文档，API 调试、API 数据 Mock、API 自动化测试，通过一套系统、一份数据，解决多个系统之间的数据同步问题。

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位 Postman + Swagger + Mock + JMeter。

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

1. 为什么不用Postman而要使用ApiFox

1.1. Postman的问题(不便)

1. 多系统数据不互通

API设计者、前端开发、后端开发、测试人员大量重复工作。

2. 效率低

可视化程度低、操作不友好。

3. 无法团队协作

单机离线使用为主，成员之间无法实时同步数据，无法协作。

4. 数据一致性困难

每次变更，都需要不同角色手动去多套系统修改，维护一致性非常困难。时间久了，不一致性越来越严重，最终不可维护。

1.2. Apifox 功能

1. 接口设计：Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范的同时，提供了非常好用的可视化文档管理功能，零学习成本，非常高效。并且支持在线分享接口文档。

2. 数据模型：可复用的数据结构，定义接口返回数据结构及请求参数数据结构（仅 JSON 和 XML 模式）时可直接引用。支持模型直接嵌套引用，直接 JSON/XML 智能导入，支持 oneOf、allOf 等高级组合模式。

3. 接口调试：Postman 有的功能，比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数，非常方便。自定义脚本 100% 兼容 Postman 语法，并且支持运行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。

4. 接口用例：通常一个接口会有多种情况用例，比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性，用接口用例来调试接口非常高效。

5. 接口数据 Mock：内置 Mock.js 规则引擎，非常方便 mock 出各种数据，并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”，根据请求参数返回不同 mock 数据。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的数据，具体在本文后面介绍。

6. 数据库操作：支持读取数据库数据，作为接口请求参数使用。支持读取数据库数据，用来校验(断言)接口请求是否成功。

7. 接口自动化测试：提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。目前接口自动化测试更多功能还在开发中，敬请期待！目标是：JMeter 有的功能基本都会有，并且要更好用。

8. 快捷调试：类似 Postman 的接口调试方式，主要用途为临时调试一些无需文档化的接口，无需提前定义接口即可快速调试。

9. 代码生成：根据接口及数据数据模型定义，系统自动生成接口请求代码、前端业务代码及后端业务代码。

10. 团队协作：Apifox 天生就是为团队协作而生的，接口云端实时同步更新，成熟的团队/项目/成员权限管理，满足各类企业的需求。

2. ApiFox的使用

2.1. 创建项目

1. 打开项目选择界面

2. 创建项目

3. 分享项目给团队

2.2. 创建环境

1. 特殊的几个参数信息

• 可以设置当前环境其他人员是否可以查看
• 环境变量供接口中使用

2.3. 创建接口

1. 创建接口

2. 编写接口的样例

2.4. 全局变量应对参数变化

1. 在全局变量中增加

2. 在Body填写信息{{Search_XZQDM}}

{
    "key": "xxxxxxxxx",
    "mapParsInfo": {
        "行政区代码": {{Search_XZQDM}}
    },
    "encryptFlag": true
}
1
2
3
4
5
6
7

2. 在环境中增加环境变量

2. 在Body填写信息{{Search_XZQDM}}

{
    "key": "xxxxxxxxx",
    "mapParsInfo": {
        "行政区代码": {{Search_XZQDM}}
    },
    "encryptFlag": true
}
1
2
3
4
5
6
7

3. 简单使用流程

1. 根据项目团队和项目所处进度打开接口状态

2. 根据接口状态制定前后端沟通流程

3. 根据模块分组组别信息（一个系统接口过多，使用分组归类显示）