推荐一款技术人必备的接口测试神器:Apifox

1. 背景

做为互联网行业技术从业者,接口调试是必不可少的一项技能,一般咱们都会选择使用 Postman 这类工具来进行接口调试,在接口调试方面 Postman 作的确实很是出色。固然除了Postman,还有它的老婆: Postwoman也一样很出色,公号以前有发表过一篇关于它老婆Postwoman使用的文章,详细可阅:推荐一款 Postman 的开源替代品: Postwomanhtml

可是在整个软件开发过程当中,接口调试只是其中的一部分,还有不少事情 Postman 是没法完成的,或者没法高效完成,好比:接口文档定义、Mock 数据、接口自动化测试等等。前端

今天给你们推荐的一款神器: Apifox,它是集:接口文档管理接口调试Mock接口自动化测试于一体的。有的读者咋一看,会以为和YAPI有点相似,但二者在功能特点上,只能说是各有千秋的。json

细心的读者,会发现文章,正文干货尚未开始,就已经为你们推荐了三款效率神器: Apifox、Postwoman、YAPI。后端

2. 聊一聊接口管理的现状

对于接口管理的现状来讲,目前行业大部分采起的解决方案有以下几种:api

  • 使用 Swagger 管理接口文档。数据结构

  • 使用 Postman 调试接口。架构

  • 使用 RAP或Easy Mock来进行 Mock 数据。框架

  • 使用 JMeter 作接口自动化测试。工具

上述的接口管理手段,咋一看,貌似没有什么问题,但仔细分析,不难发现,当中存在的问题还真很多,好比要维护不一样工具,而且这些工具之间数据一致性很是困难、很是低效。这里不只仅是工做量的问题,更大的问题是多个系统之间数据不一致,致使协做低效,频繁出问题,开发人员、测试人员痛苦不堪。性能

设想一下这样的一个协做流程:

  1. 开发人员在 Swagger 定义好文档后,接口调试的时候还须要去 Postman 再定义一遍。
  2. 前端开发 Mock 数据的时候又要去 RAP 或Easy Mock定义一遍,手动设置好 Mock 规则。
  3. 测试人员须要去 JMeter 定义一遍。
  4. 前端根据 RAP 或Easy Mock定义 Mock 出来的数据开发完,后端根据 Swagger 定义的接口文档开发完,各自测试测试经过了,本觉得能够立刻上线,结果一对接发现各类问题:原来开发过程当中接口变动,只修改了 Swagger,可是没有及时同步修改 RAP 或Easy Mock。
  5. 一样,测试在 JMeter 写好的测试用例,真正运行的时候也会发现各类不一致。
  6. 时间久了,各类不一致会愈来愈严重。

3. Apifor介绍

官方对Apifor定位,Apifox = Postman + Swagger + Mock + JMeter,以下图所示

Apifox目标是经过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就能够直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后便可保证和接口文档定义彻底一致。高效、及时、准确!

官方地址:https://www.apifox.cn/#

归纳来说,Apifox经常使用 功能分为四类功能:

  1. 接口文档定义功能:Apifox 遵循 OpenApi 3.0 (原Swagger)、JSON Schema 规范的同时,提供了很是好用的可视化文档管理功能,零学习成本,很是高效。
  2. 接口调试功能:Postman 有的功能,好比环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享 等功能,Apifox 都有,而且和 Postman 同样高效好用。
  3. 数据 Mock功能:内置 Mock.js 规则引擎,很是方便 mock 出各类数据,而且能够在定义数据结构的同时写好 mock 规则。支持添加“指望”,根据请求参数返回不一样 mock 数据。最重要的是 Apifox 零配置 便可 Mock 出很是人性化的数据,具体在本文后面介绍。
  4. 接口自动化测试:提供接口集合测试,能够经过选择接口(或接口用例)快速建立测试集。目前接口自动化测试更多功能还在开发中!目标是: JMeter 有的功能基本都会有,而且要更好用。

4. Apifor小试牛刀

接下来,带着你们,来体验一下Apifor的使用。

一、先在官网下载对应系统安装包,进行安装,安装完成后,第一次启动须要先登陆。

Ps: 登陆前,须要先经过邮箱来注册一个账号。

2、 登陆成功后,Apifox默认给了一些例子,若是看它的界面会发现和Postman界面比较类似。

Ps: 固然也不要被它的外表所欺骗了,仍是有别于Postman的。

3、在本地启一个API服务,端口为8000, 在Apifor上,新建一个新的测试环境,以下所示:

4、新建一分类:接口测试,或直接在默认分类上,新建一条接口用例,以下所示

如上图,添加对应的基础信息、配置请求参数等。

5、选择测试环境,点击发送按钮,运行接口测试用例。

看到这里,可能有些读者以为和Postman功能基本是同样的,不妨接着往下看。

5. Apifor更多特性

一、调试时自动校验数据结构

使用 Apifox 调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需经过肉识别,也无需手动写断言脚本检测,很是高效!

img

根据官方的示例能够看出,在运行集合测试时,能够结合自动校验数据结构的功能, 清晰展现出失败用例校验不经过的缘由。

img

2、零配置 Mock 出很是人性化的数据

1、 为上述示例,添加一个mock测试服务,配置以下所示:

按照接口字段数据格式要求,根据mock.js语法,配置保存完毕,运行后,自动生成一个mock服务。

其中,Mock.js语法示例可见:http://mockjs.com/examples.html

能够看出 Apifox 零配置 Mock 出来的数据和真实状况是很是接近的,前端开发能够直接使用,而无需再手动写mock规则。

3、代码自动生成

根据接口模型定义,自动生成各类语言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的业务代码(如 Model、Controller、单元测试代码等)和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。

img

更重要的是:你能够经过自定义代码模板来生成符合本身团队的架构规范的代码,知足各类个性化的需求。

4、导入、导出

  1. 支持导出 OpenApi (原Swagger)MarkdownHtml 等数据格式,由于能够导出OpenApi格式数据,因此你能够利用 OpenApi (Swagger) 丰富的生态工具完成各类接口相关的事情。
  2. 支持导入 OpenApi (原Swagger)PostmanHARRAP2yapiEolinkerDOCleverApiPostApizza 等数据格,方便迁移旧项目。

img

6. 小结

虽然Apifox目前有些功能还并不完善,但整的来讲,Apifox仍是不错的,也为接口开发调试测试提供了一种效率更佳的的解决方案,按照Apifox开发团队后续规划,后续会重加增长接口性能测试能力支持(相似JMeter)、支持离线团队多人协做等特性。

相关文章
相关标签/搜索