Apifox for Mac(API接口调试工具)

Apifox mac版是一款适用于macOS系统的API接口调试工具，集API文档、API调试、API Mock、API自动化测试多项实用功能为一体，定位为 Postman + Swagger + Mock + JMeter，可以通过一套系统、一份数据，解决多个工具之间的数据同步问题，从而帮助用户快速生成接口请求、文档、代码，并进行自动化测试和数据导入导出。不仅仅如此，软件功能十分的强大，如：支持如环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享等功能，可以说非常适合前端测试人员使用。

使用Apifox，用户可以设计出新的接口，让您的程序和系统都能够正常的访问数据，甚至还可以直接在Apifox软件中编辑新的接口内容，用户在定义文档之后直接使用数据，以及能够调试接口的时候直接使用接口文档，完全是不需要再次定义新的文档内容的哦。此外在这里用户只需要定义好API文档、API调试、API数据Mock以及API自动化测试就可以直接进行使用，完全不需要再次进行定义，其中API文档和API开发调试可以使用同一个工具，在API调试之后就即可保证和API文档定义完全一致，使用起来非常的高效、及时、准确，有感兴趣的朋友可以来本站下载。

软件功能

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

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

API 文档和 API 开发调试使用同一个工具，API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确！

二、可视化 API 设计

1、高效 & 零学习成本

可视化 API 文档设计功能，无需手写 Markdown 或 YAML，零学习成本，高效便捷。

2、可复用的“数据模型”

可将常用数据结构定义为“数据模型”，在多个接口中引用，一次修改全局生效。

3、遵循 OpenAPI(Swagger) 规范

接口文档完全遵循 OpenAPI(Swagger) 规范，支持 JSON Schema

4、可导入 Swagger 等 20+ 数据格式

支持导入 Swagger (OpenAPl) , Postman, Jmeter, apiDoc, RAP2, YApi, Eolink, Apipost 等数据格式。

三、比 Postman 更强大

1、一键调试，无需复制黏贴

只要设计完（或导入）API 文档，即可一键调试，无需复制黏贴各种 URL 或参数。

2、“自动校验”返回数据结构的正确性

依据接口文档自动判断返回数据结构是否正确，无需手写断言。

3、独创的“接口用例”功能

保存多组接口请求参数，轻松覆盖一个接口的各种实例，方便后端自测和测试编写用例。

4、全面兼容 Postman 功能和脚本语法

Postman 的接口前置脚本和测试脚本可以直接在 Apifox 内运行，并支持引用公共脚本。

5、支持 JS/Java/Python/PHP 等语言

脚本中支持引用 JS/Java/Python/PHP 等语言的包。

四、零门槛实现自动化测试

1、可视化编排测试步骤，零代码

支持可视化地编排自动化测试步骤，无需手写脚本代码。

2、API 文档基础上，一键导入，实时同步

基于设计好的 API 文档，一键导入，自动生产“自动化测试用例”，无需手动添加，并且 API 变更实时自动同步。

3、可视化添加断言，支持读写数据库

接口用例支持可视化的断言，也可连接MySQL等多种数据库读写数据。

4、支持“数据驱动”测试

可导入CSV/JSON 格式的测试数据，使用测试数据运行测试用例并产出测试报告。

5、支持 CI/CD 持续集成

支持使用命令行方式运行测试用例并产出测试报告，可与 Jenkins等持续集成工具打通使用。

五、分享&发布 API 文档

1、一键发布&分享

设计完（或导入） 的API 文档，一键分享给合作伙伴，接口变更实时同步，支持公开或加密发布。

2、API 文档支持“在线调试”

API 文档页面支持“调试”功能，可以在线请求真实接口并返回数据。

3、自定义导航、自定义样式

API 文档可自定义导航和页面样式，可以将 API 文档的导航条做成跟官网一致。

4、个性化域名、自定义域名

支持自定义的 Apifox 文档域名，也可绑定到自有的域名。

5、自动生成代码

在线文档支持生成20 多种语言的接口请求代码和数据模型代码。

六、零配置 Mock 数据

1、无需手写 Mock 规则

只要定义好 API 文档，“零配置”即可自动 mock 出非常“人性化”的数据（根据数据结构及字段名智能 mock）

2、API 变更后 Mock 数据实时同步变更

API 文档更改时，Mock 数据会自动变更，无需改动任何脚本。

3、支持根据请求参数返回不同结果

高级 Mock 支持配置不同的期望，根据请求参数返回不同结果。

4、内置 Mock.js 规则引擎

内置 Mock.js 规则引擎，可自定义符合 Mock.js 语法的 Mock 脚本。

5、支持自定义脚本 Mock

自定义脚本 Mock 支持二次修改智能 Mock 的结果，实现 Mock 字段之间的逻辑关联。

Apifox基本使用教程

一、如何解决这些问题

1、定位

Apifox = Postman + Swagger + Mock + JMeter

它是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。

通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好接口文档，接口调试、数据 Mock、接口测试就可以直接使用，无需再次定义；接口文档和接口开发调试使用同一个工具，接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确！

2、宗旨

节省研发团队的每一分钟！

二、Apifox 做的不仅仅是数据打通

如果你认为该软件只做了数据打通，来提升研发团队的效率，那就错了还做了非常多的创新，来提升开发人员的效率。

1、接口支持“用例管理”

通常一个接口会有多种情况用例，比如正确用例参数错误用例数据为空用例不同数据状态用例。定义接口的时候定义好这些不同状态的用例，接口调试的时候直接运行，非常高效。

2、“数据模型”定义、引用

可以独立定义数据模型，接口定义时可以直接引用数据模型，数据模型之间也可以相互引用。同样的数据结构，只需要定义一次即可多处使用；修改的时候只需要修改一处，多处实时更新，避免不一致。

3、调试时“自动校验”数据结构

使用它调试接口的时候，系统会根据接口文档里的定义，自动校验返回的数据结构是否正确，无需通过肉眼识别，也无需手动写断言脚本检测，非常高效！

4、“可视化”设置断言

设置断言：

运行后，查看断言结果：

5、“可视化”设置提取变量

6、支持数据库操作

7、“零配置”Mock 出非常人性化的数据

先放一张图对比下 Apifox 和其他同类工具零配置mock 出来的数据效果：

Apifox Mock 数据结果对比同类工具

可以看出零配置Mock 出来的数据和真实情况是非常接近的，前端开发可以直接使用，而无需再手动写 mock 规则。

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

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

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

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

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

8、生成在线接口文档

项目可“在线分享” API 文档，分享出去的 API 文档可设置为公开或需要密码访问，非常方便与外部团队协作。

9、代码自动生成

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

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

10、导入、导出

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

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

支持定时自动导入OpenApi (Swagger)、apiDoc、Apifox格式数据。

常见问题

1、使用 Postman 调用接口返回正常，而返回错误

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

查看实际请求内容方法：

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

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

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

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

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

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

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

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

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

优先级顺序如下：临时变量>环境变量>全局变量。

更新日志

v2.6.7版本

【新功能】HTTP 项目 支持 接口版本 的创建与管理，包括全量的 HTTP 接口、数据模型、响应组件、Markdown 文档 资源

【新功能】可以创建 通用接口文档 来管理自定义协议的文档，支持配置协议名称和唯一标识，支持 在线分享

【新功能】可以配置接口目录在 在线文档 中的展示方式，可选项为普通目录、模块标题、跳转到子目录

【新功能】可以 定时导入 YApi 格式的数据

【优化】调试接口、用例时，在发送请求之前，默认折叠 返回响应 区域

【优化】调试接口、用例时，如果光标在地址栏内，可以直接通过回车键发送请求

【优化】导入 Markdown 文档时，如果目录和名称都相同，则视为同名文件

解决暂停自动化测试再继续运行时，某些情况下报错的问题

解决导入 ShowDoc 格式的数据时，某些情况下报错的问题

解决导入 apiDoc 格式的数据时，某些情况下界面失去响应的问题