Apifox(接口调试工具)

　　Apifox提供接口开发功能，可以通过这款软件设计新的接口，让您的程序和系统可以正常访问数据，直接在软件编辑新的接口内容，定义文档以后直接使用数据，调试接口的时候就可以直接使用接口文档，不需要再次定义新的文档内容，软件功能很多，支持接口管理、测试管理、数据模型、项目设置等功能，支持新建接口、新建分类、快捷调试、导入、导入抓包数据，支持快捷调试功能，在软件输入请求地址就可以开始调试，提供测试用例，主要用来做接口集合测试，每个测试用例包含多个测试步骤，每个测试步骤都是一个接口请求，测试步骤较多时，建议拆分成多个测试用例，然后用测试套件将多个测试用例集合在一起运行。

软件功能

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

　　2、数据模型：可复用的数据结构，定义接口返回数据结构及请求参数数据结构（仅 JSON 和 XML 模式）时可直接引用。

　　3、接口调试：Postman 有的功能，比如环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享 等功能，Apifox 都有，并且和 Postman 一样高效好用。接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数，非常方便。

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

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

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

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

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

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

软件特色

　　Mock 功能可以根据接口/数据结构定义、Mock规则配置、Mock 期望配置，自动生成模拟数据，且使用者可以根据需要灵活构造各种结构的接口数据。

　　通常情况 Apifox 零配置即可生成非常人性化的 mock 数据：

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

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

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

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

安装方法

　　1、打开Apifox100.exe软件就可以直接安装，点击下一步安装软件

　　2、提示软件的安装进度界面，等待主程序安装结束吧

　　3、显示Apifox成功安装完毕的提示，点击完成

使用说明

　　1、打开Apifox 提示登录功能，可以在软件界面输入账号进入调试界面

　　2、项目设置功能，直接在软件上新建项目内容

　　3、接口路径以/起始,HTTP协议及域名部分请在环境变量的前置URL里定义。

　　4、新建分类功能，在软件为测试项目新建分类，可以二傻子父级分类

　　5、项目基本信息，显示项目ID、项目名字、描述内容

　　6、智能 Mock 说明：当接口设计的返回 Response (或数据模型) 里的字段未配置 mock 规则时，系统会自动使用智能 Mock 规则生成数据，以实现使用时 “零配置” 即可 mock 出非常人性化的数据

　　7、数据导入功能，提示：支持导入 OpenAPI 3、Swagger 1、2、3数据格式的json或yaml文件。

　　8、导出数据

　　OpenAPI 格式 (Swagger 3.0)、HTML格式、Markdown格式、Apifox 格式

　　9、测试功能

　　功能说明：测试用例主要用来做接口集合测试，每个测试用例包含多个测试步骤，每个测试步骤都是一个接口请求。测试步骤较多时，建议拆分成多个测试用例，然后用测试套件将多个测试用例集合在一起运行

　　10、数据模型界面，在软件创建新的数据结果，可以通过JSON智能识别导入

　　11、测试套件

　　功能说明：测试套件为测试用例的集合，每个测试套件包含多个测试用例。

　　12、测试报告

　　注意：目前测试报告数据仅存放在本地电脑，团队成员之间互不可见，未来会考虑增加成员之间同步功能

官方教程

　　快速上手

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

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

　　导入抓包数据 (cURL)

　　快速导入 Chome、Charles 或 Fiddler 等工具的抓包数据。

　　快速上手

　　1、使用 Chome、Charles 或 Fiddler 等工具抓包，然后复制为cURL格式。

　　Chrome 使用方式：打开 Chrome 开发中工具，抓包，找到对应接口请求，单击右键->Copy->Copy as cURL，如下图所示。

　　Charles 使用方式：抓包，找到对应接口，单击右键->Copy cURL Request，如下图所示。

　　Fiddler 使用方式：抓包，点击左上角菜单 File->Export Sessions->Selected Sessions，选项第一个默认 cURL script，点击Next即可保存为.bat文件，文件编辑工具打开该.bat ，复制内容即可。查看详细使用说明

　　2、鼠标移到左侧搜索框旁边的 + 号按钮，在下拉列表里点击导入抓包数据，也可使用 快捷键 Ctrl(⌘) + I。

　　3、在打开的窗口中，粘贴从前面抓包数据里复制的 cURL 格式数据。

　　4、点击确定按钮，即可看到抓包的数据已复制到如下快捷调试界面。

　　5、快捷调试窗口可以直接调试接口，点击保存按钮，可以保存为接口。

　　插件安装、开发

　　说明

　　Apifox 目前已支持 2 种类型插件，未来会支持更多类型插件：

　　Socket 封包插件

　　Socket 解包插件

　　开源插件

　　欢迎各位贡献代码。

　　github 地址：https://github.com/apifox/apifox-extensions

　　gitee 地址：https://gitee.com/apifox/apifox-extensions

　　开发自定义插件

　　插件目录

　　每个插件都一个文件夹，至少包含一个 JavaScript 文件。所有插件都需要放在 Extensions目录下。点击软件右上角设置形状的 icon ，选择插件管理，即可查看插件安装目录。

　　每一个插件都需要一个唯一的插件 ID，该 ID 需要使用倒置的域名作为前缀，如cn.apifox.ApifoxExtensions.SocketRedisUnpacker。

　　插件目录名必须和插件 ID相同。

　　插件脚本

　　插件目录下，需要包含一个 JavaScript 文件（支持 ES6 语法，CommonJS 模块化），该文件名必须为插件ID最后一个.后面部分，如SocketRedisUnpacker.js。

　　该 JavaScript 内容为一个 JavaScript 类，该类必须包含如下静态属性：

　　id：即插件ID，必须和插件目录名完全一致。

　　title：插件名

　　type：即插件类型，取值为如下

　　socketPacker：Socket 封包插件

　　socketUnpacker：Socket 解包插件

　　插件脚本可以使用npm包，参考：插件中使用 npm 包

　　#Socket 封包插件

　　Socket 封包插件类必须包含一个名为evaluate的方法，用来处理封包逻辑。

　　#Socket 解包插件

　　Socket 解包插件类必须包含一个名为onData的方法，用来处理解包逻辑。

持续集成

　　Apifox 的测试用例和测试套件支持导出Apifox CLI、Postman、Jmeter 格式数据做持续集成。

　　一、Apifox CLI 方式

　　Apifox CLI 是 Apifox 的命令行运行工具，主要用来做持续集成。

　　注意

　　Apifox 版本号大于等于 1.0.25 才支持导出Apifox CLI格式数据。

　　目前仅支持导出数据后离线运行，后续Apifox 开放 API发布后，可以直接运行在线实时数据。

　　导出数据

　　在 Apifox 的测试用例和测试套件导出Apifox CLI格式数据。

　　安装 Apifox CLI

　　使用以下经命令安装 Apifox CLI

　　npm install -g apifox-cli

　　运行

　　apifox run examples/sample.apifox-cli.json -r cli,html

　　运行完成后测试报告会保存在当前目录下的apifox-reports目录里。

　　查看Apifox CLI 使用说明。

　　二、Newman 方式（Postman）

　　使用参考教程：Web API 持续集成：PostMan+Newman+Jenkins（图文讲解）

　　三、JMeter 方式

　　导出 JMeter 数据主要用来做性能测试，不过也可以做持续集成，参考教程：性能测试与持续集成(JMeter+Jenkins)

　　注意

　　由于 JMeter 不支持 JS 脚本，所以 Apifox 导出 JMeter 数据不包含预执行脚本和后执行脚本。

　　后续 Apifox 会将接口返回数据提取和断言功能做成界面配置，这样就可以做到导出数据和 JMeter 兼容了。