Apifox中文版

Apifox中文版是一款集 API 接口管理、Mock 数据生成、自动化测试于一体的开发者工具，内置强大的API测试框架，支持编写测试用例并执行自动化测试，提升测试效率，它支持中文界面，界面简洁易懂，适合中文用户使用，Apifox支持在线分享接口文档，团队间不需要反复导出、发送接口文档，它不仅适用于前后端开发人员，也适合产品经理、测试工程师等团队成员使用。

Apifox中文版采用现代化的设计语言，操作简单易懂，降低学习成本，对于需要执行大量API测试的开发人员和测试人员来说，可以大大提高工作效率和质量，同时提供了详尽的文档和教程，帮助新用户迅速掌握核心功能。

软件特色

一、一站式接口协作平台

Apifox = Postman + Swagger + Mock + JMeter

一套系统、一份数据，解决多个 API 工具之间的数据同步问题

只要定义好 API 文档，API 调试、API Mock、API 自动化测试即可直接使用，无需再次定义。

API 文档和 API 开发调试使用同一个工具，API 调试完成后即可保证和 API 文档定义完全一致。

二、接口设计所见即所得

Apifox 接口文档遵循 OpenAPI 3.0 (原 Swagger)、JSON Schema 规范的同时，提供了非常好用的可视化文档管理功能，零学习成本，非常高效。并且支持在线分享接口文档。同一个接口通常会有多种情况，比如正确用例、参数错误用例、数据为空用例、不同数据状态用例。设计接口时支持定义各个接口的状态。

三、一次请求，重复调用

无需提前定义接口即可快速调试。支持设置环境变量、前置/后置脚本、Cookie/Session 全局共享等功能。接口运行调试完成后支持一键保存，后续无需输入参数即可重复运行接口用例，十分便利。

四、自动生成代码

根据接口模型定义，自动生成各种语言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的业务代码（如 Model、Controller、单元测试代码等）和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。

更重要的是：你可以通过自定义代码模板来生成符合自己团队的架构规范的代码，满足各种个性化的需求。

自定义脚本支持运行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。

五、智能化接口管理

使用 Apifox 调试接口的时候，系统会根据接口文档里的定义，自动校验返回的数据结构是否正确。不再需要通过肉眼识别，也无需手动写断言脚本检测。运行接口用例时会自动校验数据正确性，提升调试效率。根据接口及数据数据模型定义，系统还能够自动生成接口请求代码、前端业务代码及后端业务代码。

六、丰富的实用能力

1、接口数据 Mock：

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

2、Apifox 如何做到高效率、零配置生成非常人性化的 mock 数据

- Apifox 根据接口定义里的数据结构、数据类型，自动生成 mock 规则。

- Apifox 内置智能 mock 规则库，根据字段名、字段数据类型，智能优化自动生成的 mock 规则。如：名称包含字符串image的string类型字段，自动 mock 出一个图片地址 URL；包含字符串time的string类型字段，自动 mock 出一个时间字符串；包含字符串city的string类型字段，自动 mock 出一个城市名。

- Apifox 根据内置规则，可自动识别出图片、头像、用户名、手机号、网址、日期、时间、时间戳、邮箱、省份、城市、地址、IP 等字段，从而 Mock 出非常人性化的数据。

- 除了内置 mock 规则，用户还可以自定义规则库，满足各种个性化需求。支持使用 正则表达式、通配符 来匹配字段名自定义 mock 规则。

3、数据库操作：

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

4、接口自动化测试：

提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。

七、云端团队协作

接口信息云端实时同步更新，天生响应团队协作。成熟的团队/项目/成员权限管理系统满足各类企业的需求。数据模型之间支持相互引用，同样的数据结构，只需要定义一次即可多处使用；修改时仅需修改一处，多处实时更新。

八 、兼容多种数据格式

1、支持导出 OpenApi (Swagger)、Markdown、Html 等数据格式，因为可以导出OpenApi格式数据，所以你可以利用 OpenApi (Swagger) 丰富的生态工具完成各种接口相关的事情。

2、支持导入 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等数据格式，方便旧项目迁移。

3、支持定时自动导入OpenApi (Swagger)、apiDoc、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，进入对应项目，鼠标移到左上角更多功能点击分享项目（注意仅项目创建者有权限分享项目），创建分享 (注意“阅读密码”必须设置为空)，然后复制分享地址将地址黏贴到下面输入框。如下图所示：

常见问题

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

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

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