Apifox使用介绍

Apifox使用介绍

一、Apifox简介

Apipost是一个支持模拟POST,GET,PUT等常见HTTP请求,支持团队协作,并可直接生成并导出接口文档的API文档,调试,Mock,测试一体化协作平台。

定位：Apifox = Postman + Swagger + Mock + JMeter

官网下载地址：https://www.apifox.cn/

安装：默认安装即可，无特殊配置

二、Apifox使用说明

1. 新建团队
   Apifox支持团队协同办公，可根据需要创建自己的团队，并进行成员管理、权限管理等
   

2. 新建项目
   团队建好后，在团队内新建项目，以此来进行接口管理。企业内项目建议设置为私有项目。
   

3. 导入接口
   Apifox支持多种格式导入。若要导入Postman里维护的接口，则需先从Postman导出，且导出格式为Collection v2.1 (recommended)
   
   

4. 新建接口
   如图，维护好接口请求方法、URL、请求参数等。
   

5. 编辑接口
   在如下图-修改文档页面可对接口信息进行维护
   

6. 环境管理
   通常我们管理的项目会分为线上、测试、开发环境等多套环境。接口维护好后，可将URL里的HTTP协议及域名部分设为变量，并在环境管理中进行配置。后续在调试、测试时可灵活切换环境进行验证。
   

7. 运行接口
   在接口管理-运行下，修改参数值，点击发送按钮即可运行接口，查看返回信息。需注意的是，运行接口前，右上角需先选择环境。
   另外，可将运行的数据保存为用例。
   

8. 用例维护
   接口设置好参数后运行并保存为用例，添加用例的后置操作完成用例编写。
   
   用例的后置操作常用的有断言、自定义脚本等。其中断言配置如下图：
   
   表达式的提取，$后为根节点，例如要提取machineVerifyEnable，则表达式为 $.data.machineVerifyEnable

   {
   	"ret": 1,
   	"data": {
   		"machineVerifyEnable": true,
   		"machineVerifyConfigs": [
   			{
   				"supplierType": 0,
   				"verifyTypes": [
   					0,
   					1
   				],
   				"appKey": "FFFF0N00000000008E28"
   			}
   		],
   		"machineVerifyAppKey": "FFFF0N00000000008E28"
   	},
   	"statusCode": 200,
   	"bizCode": 900200,
   	"error": null,
   	"_store": "CHINA_GET_/manager/user-manager/api/v1/config/global"
   }
   

   用例维护好后会显示在接口的下一级节点：

9. 批量运行
   在自动化测试中，可以导入接口用例，用于批量运行管理。由于项目涉及公司机密，此处引用Apifox官方截图。
   

10. 测试报告
    批量运行后，Apifox可自动生成测试报告