Apifox使用

Apifox

入门

1. 在获取一个URL后，可以点击快捷请求（ctrl T），粘贴URL即可快速识别参数（支持修改），可添加header、body等；
   
   

2. 点击发送，即可获得结果。易于Postman的导入；
   

3. 点击保存，命名后，即可获得自动生成的接口文档；
   

设计API

1. 新建接口（ctrl N）进入接口设计界面，举例使用/user/{id}，单大括号内容自动识别为Path参数并出现在列表中；
   
2. 可以在组件库---默认相应模板中设计公司规范接口结构，之后新建的接口都有此默认模板；
   
3. 可以自定义数据结构中参数类型，在数据模型中可以创建常用引用类型供参数选择使用；
   
4. 在响应示例中可以选择成功/失败示例，并可自动生成对应内容；
   
5. 若没有自定义数据结构，可选择通过JSON等生成，选择使用JSON、XML、JSON Schema、数据库导入、Mockjs进行数据结构的生成；
   
   
6. 继续选择添加响应组件，生成200 201 401 404等；
   
7. 若使用swagger，可以选择导入数据---定时导入，新建数据源并借此使用各种功能
   
8. 若使用IDEA Spring、Kotlin，添加Apifox Helper插件即可快速进行api文档的创建；
   

开发API

1. 生成代码---生成业务代码(后端)/接口请求代码(前端)进入生成界面，选择使用语言、代码风格，即可生成并自行补充业务逻辑；
   
2. 进入运行界面，兼容Postman的功能，还有自身的额外功能，可以自动生成body等，其中动态值可以读取变量、生成数据等；
   
3. 在选择切换环境并发送后，可以在下部观察到返回响应和校验响应，判定对应内容进行自测；
   
4. 在每个运行中都可以选择前/后置操作，添加例如断言、提取变量、数据库操作、自定义脚本等，可以对后续流程提供内容。可以自定义公共脚本供给常用功能的复用；
   
5. 在每个接口内，都可以创建其测试用例，用以保存参数值，方便测试时引用；
   
6. 若习惯于先写代码再编写文档的话可以调整到调式模式，先将接口跑通，让其自动生成api文档；
   

API Mock

1. 在api文档中有Mock区域，能够自行匹配字段生成数据，存放在一个JSON格式URL中；
   
2. 若有的字段过于复杂，可以手动设定数据生成，在修改文档根据不同要求，对字段设定Mock语法；
   
3. 字段支持枚举、最大最小长度等设置，Mock内容也会依次改变；
   

自动化测试

1. 在自动化测试中可以新建测试场景，并选择接口流程，同时支持每个流程的细节面板；
   
2. 运行后显示完成情况，并显示校验响应结果；
   
3. 支持数据驱动的测试，将参数修改为变量后eg.{{id}}，可以在测试数据---新建中导入csv文件（首行为参数名，后续为值），选择使用导入的数据即可以数据驱动；
   
   
   
4. 在复杂场景编排中，可以在某个接口中的参数值使用前置步骤返回的值；
   
5. 在测试过程中允许使用流程控制控件，支持选定特定数组作为流程变量；
   
6. 在根目录---全部场景中可以选择多个测试场景同时进行测试；
   

API文档

1. 在分享文档选择新建文档，设置运行环境等内容即可生成一个在线文档；
   
2. 在线文档中可以直接调试，并在线运行，类似嵌入Postman；
   
3. 可以选择不同语言示例代码；
   
4. 返回响应中可以生成不同语言的数据模型，以便直接使用对应内容；
   

导入导出

1. 支持不同格式内容导入，便于数据迁移；
   
2. 维护后的数据也可简单导出；