apifox--介绍

末蓝、 2023-09-29 09:24 1阅读 0赞

原文网址：[apifox--介绍\_IT利刃出鞘的博客-CSDN博客][apifox--_IT_-CSDN]

## 简介 ##

**说明**

本文介绍apifox工具，它是API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位是：Postman + Swagger + Mock + JMeter。

简单来说：apifox只使用一份接口的数据，接口的文档、测试、Mock、测试全都使用这一份数据。

**官网**

[https://www.apifox.cn/][https_www.apifox.cn]

[https://www.apifox.cn/help/app/introduce/][https_www.apifox.cn_help_app_introduce]

**apifox的优点**

1.  避免了代码和文档不同步的问题（自动将swagger同步到文档中）
2.  避免重复劳动（swagger写好后，一键同步，文档、调试、Mock、测试 的数据全部自动生成）
3.  开发效率高（功能很强大。比如：可以在自测时指定全局的token）

## 开发方案对比 ##

### **传统的开发方案**（以yapi为例） ###

1.  后端写好接口的入参和返回值
2.  后端通过EasyYapi插件将接口信息同步到yapi服务端
3.  前后端同步开发
    
    1.  前端的开发及自测
        
        1.  开发：前端对照yapi文档进行开发
        2.  自测：前端使用yapi自动生成的mock进行自测
    2.  后端的开发及自测
        
        1.  开发：后端完善自己的接口
        2.  自测：后端通过EasyYapi插件将接口数据导出到postman里边，进行自测
            
            1.  yapi不支持在页面上自测。
                
                1.  虽然可以加一些插件在yapi页面上自测，但很麻烦，而且会有如下问题
                    
                    1.  yapi页面是公共的，指定为自己的开发环境是不好的
            2.  postman自测接口的缺点
                
                1.  不方便指定全局的token
                    
                    1.  现在的token一般是通过header的形式传。postman只能将这个token变量，然后每测一个接口都要去引入这个变量，很心累！

### **apifox推荐的开发方案** ###

1.  前端（或后端）在 Apifox 上定好接口文档初稿。
2.  前后端 一起评审、完善接口文档，定好接口用例。
3.  前端 使用系统根据接口文档自动生成的 Mock 数据进入开发，无需手写 mock 规则。
4.  后端 使用接口用例 调试开发中接口，只要所有接口用例调试通过，接口就开发完成了。如开发过程中接口有变化，调试的时候就自动更新了文档，零成本的保障了接口维护的及时性。
5.  后端 每次调试完一个功能就保存为一个接口用例。
6.  测试人员 直接使用接口用例测试接口。
7.  所有接口开发完成后，测试人员（也可以是后端）使用集合测试功能进行多接口集成测试，完整测试整个接口调用流程。
8.  前后端 都开发完，前端从Mock 数据切换到正式数据，联调通常都会非常顺利，因为前后端双方都完全遵守了接口定义的规范。

### **我推荐的开发方案** ###

1.  后端写好接口的入参和返回值
2.  后端通过swagger的地址将接口信息同步到apifox
3.  前后端同步开发
    
    1.  前端的开发及自测
        
        1.  开发：前端对照apifox文档进行开发
        2.  自测：前端使用apifox自动生成的mock进行自测
    2.  后端的开发及自测
        
        1.  开发：后端完善自己的接口
        2.  自测：
            
            1.  **后端直接使用apifox进行自测**
                
                1.  **apifox可以指定多个环境（开发、测试、mock）**
4.  后端 每次调试完一个功能就保存为一个接口用例。
5.  测试人员 直接使用接口用例测试接口。
6.  所有接口开发完成后，测试人员（也可以是后端）使用集合测试功能进行多接口集成测试，完整测试整个接口调用流程。
7.  前后端 都开发完，前端从Mock 数据切换到正式数据，联调通常都会非常顺利，因为前后端双方都完全遵守了接口定义的规范。

## apifox详述 ##

### 接口管理现状 ###

#### 一、常用解决方案 ####

1.  使用 Swagger 管理 API 文档
2.  使用 Postman 调试 API
3.  使用 mockjs 等工具 Mock API 数据
4.  使用 JMeter 做 API 自动化测试

#### 二、存在的问题 ####

维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题，更大的问题是多个系统之间数据不一致，导致协作低效、频繁出问题，开发测试人员痛苦不堪。

1.  开发人员在 Swagger 定义好文档后，接口调试的时候还需要去 Postman 再定义一遍。
2.  前端开发 Mock 数据的时候又要去 mockjs 定义一遍，还需要手动设置 Mock 规则。
3.  测试人员需要去 JMeter 再定义一遍。
4.  前端根据 mockjs Mock 出来的数据开发完，后端根据 Swagger 定义的接口文档开发完，各自都试测试通过了，本以为可以马上上线，结果一对接发现各种问题：
    
    1.  开发过程中接口变更了，只修改了 Swagger，但是没有及时同步修改 mockjs。
    2.  后端开发的接口数据类型和文档不一致，肉眼难以发现问题。
5.  同样，测试在 JMeter 写好的测试用例，真正运行的时候也会发现各种不一致。
6.  时间久了，各种不一致会越来越严重。

### **Apifox 解决方案** ###

#### 一、如何解决这些问题 ####

**1、Apifox 定位**

Apifox = Postman + Swagger + Mock + JMeter

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

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

**2、Apifox 功能**

1.  **接口设计**：Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范的同时，提供了非常好用的可视化文档管理功能，零学习成本，非常高效。并且支持在线分享接口文档。
2.  **数据模型**：可复用的数据结构，定义接口返回数据结构及请求参数数据结构（仅 JSON 和 XML 模式）时可直接引用。支持模型直接嵌套引用，直接 JSON/XML 智能导入，支持 oneOf、allOf 等高级组合模式。
3.  **接口调试**：Postman 有的功能，比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数，非常方便。自定义脚本 100% 兼容 Postman 语法，并且支持运行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。
4.  **接口用例**：通常一个接口会有多种情况用例，比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性，用接口用例来调试接口非常高效。
5.  **接口数据 Mock**：内置 Mock.js 规则引擎，非常方便 mock 出各种数据，并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”，根据请求参数返回不同 mock 数据。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的数据，具体在本文后面介绍。
6.  **数据库操作**：支持读取数据库数据，作为接口请求参数使用。支持读取数据库数据，用来校验(断言)接口请求是否成功。
7.  **接口自动化测试**：提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。目前接口自动化测试更多功能还在开发中，敬请期待！目标是： JMeter 有的功能基本都会有，并且要更好用。
8.  **快捷请求**：类似 Postman 的接口调试方式，主要用途为临时调试一些无需文档化的接口，无需提前定义接口即可快速调试。
9.  **代码生成**：根据接口及数据数据模型定义，系统自动生成接口请求代码、前端业务代码及后端业务代码。
10. **团队协作**：Apifox 天生就是为团队协作而生的，接口云端实时同步更新，成熟的团队/项目/成员权限管理，满足各类企业的需求。

## apifox功能截图 ##

### 开发界面 ###

接口信息

![f8d33f086a4633fe7b55a6e3c9a9bffd.png][]

自测用例

![3a7dd035f32f648912826da8661d1a03.png][]

自定义断言

![966f71aa9a917bbef92a20fab0b120f8.png][]

模型

![4867763343e485941142442b41d867a3.png][]

### 自动化测试 ###

测试用例

![4652f82b94c97705dd572048e6cf4a07.png][]

测试结果

![954059f7995ba35624a02c23bc0c65a6.png][]

测试报告

![97a802a731fb326281d63726a9bb6190.png][]

接口结果

![6bbe83f1f91dd1a7331268e2b56a5cb3.png][]

[apifox--_IT_-CSDN]: https://knife.blog.csdn.net/article/details/124056935
[https_www.apifox.cn]: https://www.apifox.cn/
[https_www.apifox.cn_help_app_introduce]: https://www.apifox.cn/help/app/introduce/
[f8d33f086a4633fe7b55a6e3c9a9bffd.png]: https://img-blog.csdnimg.cn/img_convert/f8d33f086a4633fe7b55a6e3c9a9bffd.png
[3a7dd035f32f648912826da8661d1a03.png]: https://img-blog.csdnimg.cn/img_convert/3a7dd035f32f648912826da8661d1a03.png
[966f71aa9a917bbef92a20fab0b120f8.png]: https://img-blog.csdnimg.cn/img_convert/966f71aa9a917bbef92a20fab0b120f8.png
[4867763343e485941142442b41d867a3.png]: https://img-blog.csdnimg.cn/img_convert/4867763343e485941142442b41d867a3.png
[4652f82b94c97705dd572048e6cf4a07.png]: https://img-blog.csdnimg.cn/img_convert/4652f82b94c97705dd572048e6cf4a07.png
[954059f7995ba35624a02c23bc0c65a6.png]: https://img-blog.csdnimg.cn/img_convert/954059f7995ba35624a02c23bc0c65a6.png
[97a802a731fb326281d63726a9bb6190.png]: https://img-blog.csdnimg.cn/img_convert/97a802a731fb326281d63726a9bb6190.png
[6bbe83f1f91dd1a7331268e2b56a5cb3.png]: https://img-blog.csdnimg.cn/img_convert/6bbe83f1f91dd1a7331268e2b56a5cb3.png