技术必备:推荐一款超强接口管理神器 Apifox
去年,给大家推荐了一款新面市不久的接口测试神器:Apifox,最近一年,Apifox官方又发布了一些新特性,趁此机会,再给大家分享一波。
简单来说,Apifox它是集:接口文档管理
、接口调试
、Mock
、接口自动化测试
于一体的全流程集成工具,覆盖从开发->测试->管理
等环节,等同于 Postman + Swagger + Mock + JMeter
几款工具功能累加。
利用Apifox可以实现:
-
通过Apifox可实现一套系统、一份数据,解决多个系统之间的数据同步问题。
-
只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;
-
接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。
1. 从接口管理现状聊起
在提及Apifox之前,需要先从接口管理现状聊起,对于接口管理的现状来说,目前行业大部分采取的解决方案有如下几种:
- 使用 Swagger 管理接口文档。
- 使用 Postman 调试接口。
- 使用 RAP或Easy Mock来进行 Mock 数据。
- 使用 JMeter 做接口自动化测试。
- 现有方案面临的问题
维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题,更大的问题是多个系统之间数据不一致,导致协作低效、频繁出问题,开发测试人员痛苦不堪。
- 开发人员在 Swagger 定义好文档后,接口调试的时候还需要去 Postman 再定义一遍。
- 前端开发 Mock 数据的时候又要去 RAP 定义一遍,还需要手动设置 Mock 规则。
- 测试人员需要去 JMeter 再定义一遍。
- 前端根据 RAP Mock 出来的数据开发完,后端根据 Swagger 定义的接口文档开发完,各都试测试通过了,本以为可以马上上线,结果一对接发现各种问题:
- 开发过程中接口变更了,只修改了 Swagger,但是没有及时同步修改 RAP。
- 后端开发的接口数据类型和文档不一致,肉眼难以发现问题。
- 同样,测试在 JMeter 写好的测试用例,真正运行的时候也会发现各种不一致。
- 时间久了,各种不一致会越来越严重。
3. Apifox 如何解决这些问题
在前面提到了Apifox = Postman + Swagger + Mock + JMeter
它是通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!
当然如果你认为 Apifox 只做了数据打通,来提升研发团队的效率,那就错了。Apifox 还做了非常多的创新,来提升开发人员的效率。
4、Apifox 功能
1、接口支持“用例管理”
通常一个接口会有多种情况用例,比如 正确用例
参数错误用例
数据为空用例
不同数据状态用例
。定义接口的时候定义好这些不同状态的用例,接口调试的时候直接运行,非常高效。
2、“数据模型”定义、引用
可以独立定义数据模型,接口定义时可以直接引用数据模型,数据模型之间也可以相互引用。同样的数据结构,只需要定义一次即可多处使用;修改的时候只需要修改一处,多处实时更新,避免不一致。
image3、调试时“自动校验”数据结构
使用 Apifox 调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需通过肉识别,也无需手动写断言脚本检测,非常高效!
image Apifox 自动校验数据结构4、“可视化”设置断言
设置断言:
image运行后,查看断言结果:
image5、“可视化”设置提取变量
image6、支持数据库操作
image7、“零配置”Mock 出非常人性化的数据
先放一张图对比下 Apifox 和其他同类工具 零配置
mock 出来的数据效果:
可以看出 Apifox 零配置
Mock 出来的数据和真实情况是非常接近的,前端开发可以直接使用,而无需再手动写 mock 规则。
Apifox 如何做到高效率
、零配置
生成非常人性化的 mock 数据
- Apifox 根据接口定义里的数据结构、数据类型,自动生成 mock 规则。
- Apifox 内置智能 mock 规则库,根据字段名、字段数据类型,智能优化自动生成的 mock 规则。如:名称包含字符串
image
的string
类型字段,自动 mock 出一个图片地址 URL;包含字符串time
的string
类型字段,自动 mock 出一个时间字符串;包含字符串city
的string
类型字段,自动 mock 出一个城市名。 - Apifox 根据内置规则,可自动识别出图片、头像、用户名、手机号、网址、日期、时间、时间戳、邮箱、省份、城市、地址、IP 等字段,从而 Mock 出非常人性化的数据。
- 除了内置 mock 规则,用户还可以自定义规则库,满足各种个性化需求。支持使用
正则表达式
、通配符
来匹配字段名自定义 mock 规则。
8、代码自动生成
根据接口模型定义,自动生成各种语言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的业务代码(如 Model、Controller、单元测试代码等)和接口请求代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。
image image更重要的是:你可以通过自定义代码模板
来生成符合自己团队的架构规范的代码,满足各种个性化的需求。
9、导入、导出
-
支持导出
OpenApi (Swagger)
、Markdown
、Html
等数据格式,因为可以导出OpenApi
格式数据,所以你可以利用 OpenApi (Swagger) 丰富的生态工具完成各种接口相关的事情。 -
支持导入
OpenApi (Swagger)
、Postman
、HAR
、RAML
、RAP2
、YApi
、Eolinker
、NEI
、DOClever
、ApiPost
、Apizza
、ShowDoc
、API Blueprint
、I/O Docs
、WADL
、Google Discovery
等数据格式,方便旧项目迁移。 - image image
5、 Apifox 后续规划
官方后续功能规划:
- 接口性能测试支持(类似 JMeter)。
- 支持插件市场,可以自己开发插件。
- 支持更多接口协议,如
GraphQL
、websocket
等。 - 支持离线使用,项目可选择在线同步(团队协作)还是仅本地存储(单机离线使用)。
需要尝鲜的,可访问 Apifox 官网下载:https://www.apifox.cn/