Apifox中文版  v2.8.47

Apifox中文版是一款非常好用的接口调试软件，功能强大，操作简单易用，轻松操作的可视化文档管理功能，支持管理员、普通成员、只读成员等等角色设置，应用apl文档、调试、mock、自动化测试等等功能，大大提高办公效率，满足各种个性化的需求。该软件提供一站式的功能服务，支持多个环境变量，在不同部署环境之间切换测试变得容易。

Apifox中文版软件特色

1.调试接口时，可以自动验证返回的数据结构是否符合定义，并快速检测数据异常。

2.内置智能Mock规则库，可根据字段名称和类型自动生成高度逼真的返回结果。

3.为设计和管理API文档提供直观的可视化界面，无需手动编写复杂代码来定义接口。

Apifox中文版软件亮点

1.支持设置多个环境变量并在团队内共享，使在不同部署环境之间切换测试变得容易。

2.提供详细的团队和项目管理权限设置，支持多个成员之间的实时协作，并同步界面更改。

3.能够在接口测试期间直接操作数据库、执行数据验证或读取数据库数据作为参数。

Apifox中文版软件优势

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

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

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

Apifox中文版导入数据方法

打开项目设置面板，点击导入/导出即可使用导入数据功能。

一、导入 OpenAPI (Swagger) 数据

支持导入 OpenAPI 3、Swagger 1、2、3数据格式的json或yaml文件。

注意：

需要URL导入的时候，需要填写的是json或yaml数据文件的 URL，而不是Swagger UI的 URL。

二、导入 Postman 数据

支持 Postman Collection v2.1 格式。

数据导出方法：找到 Postman 左侧列表 Collections，鼠标移到需要导出的集合，点击···，选择Export然后选择Collection v2.1 (recommended)即可导出，

三、导入 ShowDoc 格式数据

将从 ShowDoc 导出的Markdown 压缩包解压，会看到一个文件名为prefix_info.json的 json 文件。

导入 Apifox 的时候，选择ShowDoc格式，然后导入前面解压得到的prefix_info.json文件即可。

四、导入 Eolinker 数据

支持Eolinker 项目数据 (.json)格式。

Eolinker 数据导出方法：打开 Eolinker 里对应项目，点击左侧菜单项目设置，在项目 Tab 里点击导出项目，选择Eolinker 项目数据 (.json)，然后导出，

五、导入 ApiPost 数据

支持 ApiPost HTML 格式数据格式.

数据导出方法：打开 ApiPost，点击左侧导航项目，选择对应项目，点击右侧分享项目文档，在浏览器打开分享链接，在打开的网页里，找到右上角离线导出，选择导出HTML，然后导出，

六、导入 DOCWAY 数据

支持 DOCWAY 复制分享地址的方式导入数据。

使用方法：打开 DOCWAY，进入对应项目，鼠标移到左上角更多功能点击分享项目(注意仅项目创建者有权限分享项目)，创建分享 (注意“阅读密码”必须设置为空)，然后复制分享地址将地址黏贴到下面输入框。

Apifox软件快捷键

新建快捷调试：Ctrl + T

新建接口：Ctrl + N

保存接口 / 保存用例：Ctrl + S

发送请求：Ctrl + Enter

切换到【运行】Tab：Ctrl + Enter

强制关闭 Tab：Ctrl + Alt + W

关闭 Tab：Ctrl + W

导入抓包数据 (cURL)：Ctrl + I

导入数据：Ctrl + O

查找接口：Ctrl + F

切换到上一个 Tab：Ctrl + Shift + Tab 或 Ctrl + PageUp

切换到下一个 Tab：Ctrl + Tab 或 Ctrl + PageDown

跳转到特定标签页：Ctrl + 1 到 Ctrl + 8

跳转到最后一个标签页：Ctrl + 9

常见问题

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、为什么修改了环境变量(或全局变量)值，而引用的地方没有生效?

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

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