Apifox(接口调试工具)

apifox是款接口调试软件，其中将支持多种不同的调试数据结构，功能相当的强大，以便开发人员更加便捷的进行开发测试，以便达到提高效率的作用，相当适合前端用户人员。

apifox使用教程

1、使用场景

后端开发

接口文档管理

后端代码自动生成

接口调试

接口自测

前端开发

接口文档管理

接口数据 Mock

接口调试

前端代码自动生成

测试人员

接口调试

接口测试

性能测试

2、基本功能

1）团队协作

接口数据云端同步，实时更新；支持团队/项目管理员、普通成员、只读成员等权限管理

安装后，登录自己的账号，由团队成员邀请加入，通过后，即可共享团队所有项目的接口数据

 2）导入导出

导入接口文档

以YApi举例

从yapi平台，选择服务-数据管理，导出json格式的文件

apifox - 接口管理 - 导入，选择数据格式为YApi，导入json文件

导入成功后，点击接口管理，即可看到导入的接口数据 

导入抓包数据

3）接口&用例

定义接口的请求信息、基础状态信息、response示例信息

通过前置、后置操作，对数据进行处理和断言；

自动校验接口中定义的response数据结构，也可自定义response校验点

测试用例集

测试用例主要用来做接口集合测试，每个用例包含多个测试步骤，每个步骤都是一个接口请求

查看测试报告

可以查看历史的执行记录，目前测试报告数据仅存放在本地电脑

基本的性能测试

执行用例时，可设置循环次数、线程数，可导入批量的测试数据

4）快速mock

根据接口定义的数据结构自动生成测试数据，无需配置mock规则，方便前端调试

5）变量的管理及使用

公共数据可配置远程值：“远程值”会同步保存到服务器，仅用于成员之间相互同步，实际运行时都是读写“本地值”

自己的测试数据可配置本地值：“本地值”仅保存在本地，不会同步到服务器，团队成员之间也不会相互同步

外部使用变量：{{变量名}

脚本中获取/设置变量：通过get/set

6）数据库连接

项目设置 - 数据库连接，可管理连接的数据库

数据库连接信息仅存储在本地，不会同步到云端，所以使用时，需自己手动设置

7）自定义脚本

apifox支持多种语言脚本：java、python、PHP、js等

举个栗子

自定义python脚本，获取外部的传参

在指定目录下，放入自己的脚本

apifox调用脚本、传参

常见问题

1. Apifox 是否收费？

Apifox 公网版 (SaaS版) 免费，私有化部署版收费。

2. 登录（Auth）态如何实现？

请参考文档：登录态（Auth）如何处理

3. 接口发送请求前需要调用登录接口获取 token 放在 header，如何实现？

请参考文档：登录态（Auth）如何处理

4. B 接口请求参数依赖于 A 接口返回的数据，如何实现？

请参考文档：接口之间如何传递数据

5. 同项目下有不同域名的接口，如何处理？

方案一：在环境里新增多个服务，分别设置不同的前置 URL ,接口分组和接口维度可以指定对应的前置 URL。推荐本方案！

方案二：把域名设置成环境变量如DOMAIN_1，接口路径这样填写：https:///users。接口路径是以http://或https://起始的，系统会自动忽略里环境里前置 URL。

方案三：给不同域名接口设置不同环境，通过切换环境来运行不同域名下的接口。不推荐本方案！

6. 脚本如何读取或修改接口请求信息？

请参考文档： 脚本读取/修改接口请求信息

7. 是否支持查询数据库字段作为参数传给接口？

支持，请参考文档：数据库操作

8. 数据是存储在本地还是云端？可否离线使用？可否私有化部署？

目前 Apifox 有 Saas 版 和私有化部署版 。

Saas 版 是免费的，数据都是存在云端的，需要联网才能使用。

私有化部署版 是收费的，数据存在使用者企业内部，不连外网也可以使用。

注意

环境变量/全局变量里的 本地值 仅存放在本地，不会同步到云端，团队成员之间也不会相互同步，适合存放token、账号、密码之类的敏感数据。

9. 使用 Postman 调用接口返回正常，而 Apifox 返回错误

解决方法：对比 postman 和 apifox 实际发出的请求内容（url、参数、body、header）是否完全一样。

查看实际请求内容方法：

Apifox：返回内容下的实际请求 tab (老版本为Request tab) 里查看

Postman：点击底部状态栏里的Console查看

10. 为什么修改了环境变量（或全局变量）值，而引用的地方没有生效？

请检查环境变量、全局变量、临时变量里是不是有多个地方定义了相同名称的变量，如果有，系统会根据优先级来取值。优先级顺序如下：临时变量>环境变量>全局变量。

请检查修改的是否是本地值，环境变量（或全局变量）仅读取本地值，而不会读取远程值。

软件功能

高效团队协作

接口云端同步，实时更新。成熟的团队/项目权限管理，满足各类企业的需求。

可视化接口管理

方便快捷可视化接口管理，成倍提升团队多人协作效率。

支持数据结构(JSON Schema)管理，多接口可复用相同数据结构。

自动化测试

完善的接口自动化测试功能，保证接口数据的正确性。

支持自定义脚本，自动化检查数据正确性。自定义脚本语法 100% 兼容 Postman，降低学习成本。

自动校验数据结构

接口调试时，自动校验返回的数据结构是否符合接口文档定义，一键发现接口数据异常。

接口数据 Mock

内置 Mock.js 规则引擎，非常方便 mock 出各种数据，并且可以在定义数据结构的同时写好 mock 规则。

支持自定义期望，灵活配置根据参数值返回不同数据内容。

零配置即可 Mock 出非常人性化的数据

数据导入/导出

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

支持导入 OpenApi格式(原Swagger)、Postman、HAR、RAP2、yapi、Eolinker、DOClever、ApiPost、Apizza 等数据格式。

接口调试

Postman 有的功能，比如环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享 等功能，Apifox 都有，并且和 Postman 一样高效好用。

更新日志

v1.4.21

2022-01-18

【优化】openapi 导入，示例字段 example 的优化。

解决多前置 URL 偶现失效的情况。

新建 tab 页打开多个情况下，关闭最初的一个后再次点击新建没有打开的问题。

v1.4.20

2022-01-14

解决生成代码生成偶现失败的情况。