Apifox --- 全套服务提升了团队效率，让研测之间充满了爱（记Apifox在工程中的实际应用）【云原生】

您好我是码农飞哥感谢您阅读本文欢迎一键三连哦。 1. Python基础专栏基础知识一网打尽9.9元买不了吃亏买不了上当。 Python从入门到精通文章目录1. Api常用解决方案痛点多1.1. 工具多1.2. 存在的问题多2. Apifox的简介2.1 下载和安装3. 实战走起3.1. 创建团队码农飞哥干3.2. 创建项目码农飞哥干3.3. 邀请团队成员码农飞哥干3.4. 接口设计码农飞哥干3.4.1. 录入基本信息3.4.2. 录入入参和出参3.5 CV大法生成代码3.6. 接口数据Mock小张干3.7. 编写测试用例小美干3.8. 自动化测试小美干3.9 接口调试总结文初提个小问题你有用过Apifox么知道Apifox有哪些功能呢欢迎小伙伴们留言告诉我留言的小伙伴均有红包相送。1. Api常用解决方案痛点多1.1. 工具多大家好我是码农飞哥—作为一名后端老码农我做的大部分项目一般都是基于 Swagger 来管理 API 文档基于 Postman 来做接口调试基于 JMeter 来做接口性能测试基于RAP 等工具 Mock API 数据。常用解决方案中各个职能岗位分别用不同的工具而各个工具又相互独立完全不能协作存在着诸多问题。下面展示了在常用方案下的团队的协作情况大家各干各的活一套接口各个成员反复被录入了好几遍名为团队实则各自独立。1.2. 存在的问题多多系统数据不互通SwaggerPostmanJmeter等系统各自独立数据不能互通导致一份接口文档后端开发前端开发测试人员要重复写一遍造成了大量的重复工作。效率低SwaggerPostmanJmeter都是国外的软件这些软件一个共同点就是可视化程度低、操作不友好。无法团队协作SwaggerPostmanJmeter都是以单机离线使用为主团队成员之间无法实时同步数据无法协作。学习成本高使用的软件越多初学者就难以入手需要大量的学习成本、培训成本各种玩转SwaggerPostmanJmeter套餐了解一下。数据一致性困难每次变更都需要不同角色手动去多套系统修改维护一致性非常困难。比如后端开发在某个接口中增加了一个字段那么他本人首先需要在Swagger 上维护好该接口然后在Postman上修改该接口再告诉前端开发前端开发再在Mock.js上修改该接口的Mock最后就是告诉测试小姐姐测试小姐姐再在Jmeter上修改该接口。时间久了不一致性越来越严重最终不可维护。常用的解决方案过程虽然繁琐了亿点点团队协作虽然困难了亿点点但是这么多年都过来了又不是不能用大不了大家一起加班呗。直到某一天我偶然在CSDN上了解到Apifox这个API测试利器。它让我看了一种新的可能一种让前后端不用加班联调接口的可能一种测试小姐姐不用累死累活在Jmeter上做性能测试的可能。2. Apifox的简介Apifox何许工具也让我们打开Apifox官网康康官方的自我介绍吧。Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台定位 Postman Swagger Mock JMeter。通过一套系统、一份数据解决多个系统之间的数据同步问题。只要定义好 API 文档API 调试、API 数据 Mock、API 自动化测试就可以直接使用无需再次定义API 文档和 API 开发调试使用同一个工具API 调试完成后即可保证和API 文档定义完全一致。高效、及时、准确官方就是牛逼一句话就把Apifox介绍的明明白白了不过这里我还是想简单的整理下官方的这段话。从官方的介绍Apifox主要给我们提供四大核心功能接口设计接口设计即定义接口文档规范如接口路径、参数、返回值、数据结构等。后端开发在 Apifox上录入接口信息之后Apifox就会自动生成接口文档生成的接口文档团队所有成员均可以查看当然文档也可以分享给第三方团队。接口调试接口文档定义好之后就可以点击运行进行接口调试了。Postman上有的功能Apifox上全部有同时Apifox还增加了自己的特色功能比如保存用例的功能一个接口可以定义多个用例。接口自动化测试在Apifox上可以直接直接进行接口自动化测试也可以将测试用例和测试套件导出JMeter格式数据然后导入 JMeter 做性能测试。接口数据Mock内置 Mock.js 规则引擎非常方便 mock 出各种数据完全可以替换掉RAP工具。除了上面介绍的功能之外Apifox 还提供了 CI 持续集成、数据库操作、自动生成代码、数据导入/导出、团队协作等等开箱即用的功能。在开启下一步之前你可以先打开 Apifox使用文档 看看2.1 下载和安装Apifox的下载和安装比较简单在此我就不赘述了。Apifox安装包的下载地址》点击这里进入安装安装成功之后你需要注册登录之后才能使用 登录之后可以看到主界面就长这样整体来说Apifox的主界面设计清晰命令核心的功能点一眼就能找到主界面分为菜单区包括了接口管理接口设计接口调试功能接口Mock在这里 自动化测试接口自动化测试功能在这里项目设置就是设置项目的全局信息导入一些脚本等等。项目侧边栏包括了项目下的所有接口数据模型以及快捷请求。项目概览统计这个主界面让你一眼就能知道当前项目有多少接口多少用例多少文档在这里可以给整个项目添加前置操作后置操作等等操作。Apifox做了一个初步了解之后接下来进入实战环节来我们跟Apifox一起谈一场恋爱吧。3. 实战走起现在团队中有3个成员前端开发后端开发测试人员各一名他们的情况如下表所示姓名角色码农飞哥后端开发小张前端开发小美测试小姐姐现在码农飞哥小张小美各自在自己的电脑上安装好了Apifox并注册登录上了自己的Apifox客户端。项目的需求是开发一个会员管理项目这次我们要使用Apifox来进行Api的协同开发测试。在进入正题之前看我们先使用Apifox之后的工作流程前戏不可少如下图所示后端开发码农飞哥创建好团队和项目之后再把前端开发小张和测试小姐姐小美拉进这个项目中飞哥设计好接口文档之后小张可以直接在这套接口文档上进行接口数据Mock小美可以直接在该接口上编写测试用例。飞哥把接口开发完成之后小张就可以直接从Mock接口地址切换到真实的接口地址进行接口联调飞哥和小张联调完之后小美就可以在接口上编写用例进行自动化测试了。可以看出整个流程在Apifox中完全实现了闭环无需任何其他软件的参与团队中各个成员共享一套接口文档真的是方便又高效呀。3.1. 创建团队码农飞哥干码农飞哥创建一个团队暂且就叫它码农飞哥的团队创建团队的步骤是示例项目—新建团队—输入团队名—点击保存3.2. 创建项目码农飞哥干Apifox中是先有团队在有项目的。所以创建好团队之后就可以直接在团队里新建项目了就叫它会员管理系统的项目。创建步骤是**团队项目----新建项目—输入项目名称—保存**3.3. 邀请团队成员码农飞哥干邀请的方式有三种这里我采用的是邮箱邀请的方式以小美为例输入小美的邮箱—选择参与的项目—点击邀请即可。小美登录Apifox之后点击刷新按钮即可在消息框中收到 码农飞哥邀请点击接受之后即可加入团队。以同样的方式邀请小张小张也接受邀请之后码农飞哥的团队成员就变成了三位了这里小张和小美的权限都是普通成员即可以读取接口和修改接口。3.4. 接口设计码农飞哥干码农飞哥的团队和项目都创建好之后接下来飞哥就要设计接口文档了与Postman不同的是Apifox中接口设计和接口运行是两个不同的概念这里的接口设计的用途是定义接口文档规范。只需要如下操作即可需要注意的是接口地址接口路径以**/起始HTTP协议部分和域名部分需要在环境的前置URL**里设置一般就是http://ip地址:端口号/项目名。3.4.1. 录入基本信息基本信息里主要就是接口名称分组如果同一个项目下有很多模块的话可以给不同的模块指定不同的分组默认的分组是根目录状态用于指定该接口当前所处的状态有已发布测试中将废弃开发中几个状态给接口加状态这个设计点非常好防止某些接口还没开发完就被调用了服务前置URL如果同一个项目下有多个URL的话可以手动指定。3.4.2. 录入入参和出参请求参数这一块跟postman非常相似都是根据不同的content-type 设置不同的参数这里我会员新增接口的请求参数格式是 application/json。Apifox贴心的增加了JSON/XML 智能识别/快捷导入的功能只需要贴入一段示例的请求json串就可以提取相应的字段如果字段比较多的话就省去了一个个手动敲了真的很nice呀。Apifox中除了可以正常的设置参数名称备注是否必填等信息以外它还增加了Mock列可以针对每个字段设置不同的Mock规则后面小张同学会详细介绍。更多列 里面主要是用于设置默认值设置长度范围format等信息也是非常好用的功能哦。返回响应与请求参数类似不同之处在于返回响应里可以指定成功的返回响应也可以指定请求失败的响应如下图就添加了请求有误的响应这就完全满足了实际接口文档的需要了。按照此方式码农飞哥设计好了增删改查四个接口四个接口的初始状态都是开发中的状态。设计好接口之后码农飞哥就叫上小张小美一块开会讨论了接口文档。非常顺利的是接口文档设计暂时没啥问题。接下来码农飞哥就此进入了搬砖实现接口环节小张进入了前端开发环节接口数据Mock小美进入了编写测试用例的环节。朋友们来康康用Apifox生成的接口文档吧这简洁大方的页面谁人不爱呢作为对比也让我们来重温下丝袜哥Swagger的接口文档页面吧真的是没有对比就没有伤害swagger瞬间就不香了。3.5 CV大法生成代码码农飞哥接口都设计好了接下来就是编写代码实现接口了。Apifox为我们贴心的提供了生成代码的功能不得不说就是牛逼我们不生产代码我们只是代码的搬运工这里以新增会员接口为例选中新增会员接口— 点击 生成代码—选中 生成业务代码这里你可以跟你当前项目所使用的语言和框架来生成不同的业务代码当然你也可以自定义模板一个字牛两个字就是牛逼。3.6. 接口数据Mock小张干小张接下来轮到我小张表现了看我如何将Apifox的Mock功能玩出新花样。当码农飞哥还在扑哧扑哧写接口代码的时候我也可以同步进行开发了。虽说这时候接口还在开发中但是我可以使用Mock功能呀。在每个接口的接口文档下可以找到本地Mock和云端Mock我们无需搭建任何Mock服务即可使用针对不同的接口响应Apifox还提供了不同的Mock入口。首先让我们来看看成功200的Mock请求点击快捷请求即可跳转到快捷请求。点击发送Apifox就可以直接给我们Mock出一个响应结果。usernamebirthday等字段Mock的都比较真实。这是因为针对这些常用字段Apifox已经定义好了Mock规则。但是美中不足的是 code和msg字段给我Mock的不是特别满意我们这边约定的成功响应code值为200msg的值为请求成功。所以我们这边需要修改下这两个字段的Mock规则。针对code字段由于它是Integer类型所以可以添加**integer( min, max)** 指定其min和max都是200即可即**integer(200,200)而由于msg是字符串则只需要直接填入请求成功** 即可。 详细的Mock规则可以看这里—Mock 语法修改之后的Mock结果就跟我们预期的一致了。我小张由于要忙着写代码更多的Mock使用花样还有待读者朋友们去发掘不想发掘的小伙伴请听我下回分解。先甩个链接如何满足一个前端对 Mock 的全部幻想我三下五除二就把前端页面写好了然后拷贝一下接口请求代码就完成了自己的开发任务了。3.7. 编写测试用例小美干小美终于轮到我小美登场了该是我大显身手了测试用例安排上。还是以新增会员接口为例。首先安排一个成功的用例吧正确的数据请求参数之后点击发送然后点击保存为用例按钮。再保存一个缺少参数的用例。两个用例都安排好之后就可以看到了3.8. 自动化测试小美干测试用例编写好之后接着就是自动化测试了如下图点击新建一个测试用例。测试用例添加好之后点击进入该测试用例中。然后添加步骤–选择 从【接口用例】导入这里可以指定线程数是10 和循环次数是2。运行之后的结果是3.9 接口调试接口调试的功能就留给读者朋友们去发掘吧留言有好礼哦。总结码农飞哥的团队下 码农飞哥小张和小美首次将Apifox应用到实际的工作中取得良好的效果。整个Api协作流程在Apifox中实现了闭环。他们再也不需要在重复录入同一个接口了同时小张和码农飞哥在联调时也不用担心由于接口参数格式不对导致的联调失败的问题飞哥改了接口中的参数不需要一遍遍的告诉小张和小美了。整体来说体验非常之好。当然Apifox的功能远远不止本文中罗列的这些还有更多的功能等待着读者朋友们去发现。