前言
对开发工程师来说,不管是服务端开发,前端开发还是测试人员来说,一款好用的接口调试工具对于提升开发或测试的工作效率是不言而喻的,大家熟悉的接口调试工具有哪些呢?posetman?swagger?Jmeter ...
市面上接口调试工具可谓五花八门,种类繁多,但对开发人员来说,往往面对的真实需求是,接口调试只是一方面,在跨产品跨部门协作时,还需要导出API接口文档给其他人用,甚至在接口开发完毕后,测试人员也可以尽快参与进来协助接口的测试......
所以功能单一的接口调试工具来说,往往很难满足这么多的需求,今天,小编郑重向大家推荐一款集众多好用、且实用的功能于一体,有效提升接口调试工作效率的一款工具 Apifox 。
一、API 接口调试现状及痛点
1、功能单一
很多api调试工具,要么仅支持api调试,要么支持的可用于调试的api种类有限,假如现在需要将现有的api导出成文档,这就尴尬了。

2、交互操作体验差
很多api调试工具纯粹从工具的角度出发,调试某个接口时,在输入的参数较多时,界面视觉上比较凌乱。
3、有一定的学习成本
很多初学者在实用 postman或者Jmeter时抱怨无从下手,要特意去看学习视频,记得小编初次实用postman调用一个上传文件的接口时那可是费了不小的力气呢。
4、团队协助性较差
不同部门需要共享接口时,使用postman等工具是无法完成的,这就造成一种局面就是,当小A同事开发和调试完接口时,小B(另一个团队的成员)想尽快使用这些接口联调时还需要小A单独提供接口文档的尴尬局面。
一、Apifox 简介
官网下载地址:www.apifox.cn
先从下面这张图大概了解下Apifox提供的强大功能吧。
从上面这张图不难看出,当使用Apifox之后,所有的工作从定义接口文档开始,之后的一些列工作,比如接口调试、数据mock、自动化测试、导出规范的接口文档等,都可以通过Apifox帮你完成了。具体来说,按照官方描述,主要提供了如下核心的几类功能:
- API 文档设计: 可视化文档管理,高效便捷,零学习成本! 遵循业界的 OpenApi 3.0 (原 Swagger)、JSON Schema 规范。
- API调试: postman等相关接口调试工具备的功能在Apifox中都涵盖了,而且可视化操作更友好。
- API自动化测试:基本上覆盖了目前测试日常工作中所需的大部分接口测试场景。
- API数据与Mock : 内置 了Mock.js 规则引擎,非常方便 mock 出各种类型的数据。
二、Apifox 安装
官网下载地址 :www.apifox.cn
1、支持多种操作系统的安装
可以根据自身的需要选择不同类型的安装包进行下载使用
2、安装简单快捷
安装过程可以说零成本,将下载后的包解压,然后只需要选择好安装的目录即可完成安装。
3、快捷登录
安装完成后,可以注册一个新账户,或者干脆自己使用自己的微信账户扫码登录吧,登录完成后,就可以开始愉快的使用 Apifox了。
三、Apifox 核心功能操作演示
上文我们大概了解了一下Apifox提供的几块核心的功能,下面结合这些核心功能点,我们来实际操作并体验下这些功能的强大之处吧。
1、API文档设计
- 可视化 API 文档管理,零学习成本。
- 支持数据模型,接口之间可以复用相同数据结构。
- 接口文档完全遵循 OpenAPI(Swagger) 规范。
- 支持在线分享 API 文档,方便与外部团队协作。
1)通过界面化的操作快速创建一个API接口文档
使用过swagger进行API调试的同学有没有感觉这个界面很亲切呢
2)运行API接口
创建成功并保存接口文档之后,点击运行,就可以测试当前接口是否好使了
3)API分享
不得不说,这个云端分享的功能有点超出我的预期了,只需要简单创建分享,填写下分享的密码就可以啦
创建完毕后,复制下链接和密码
然后江这串链接复制到浏览器上,并输入密码
神奇的效果就出现了,有没有发现这个云端的界面跟app中打开的效果很像,有了这个功能,再也不用担心你在这里,他不在你身边的时候也能随时随地调试API啦。
2、API 调试
- Postman 有的功能 Apifox 都有(如环境变量、前置/后置脚本、Cookie/Session 全局共享等),并且比 Postman 更高效好用。
- 自动校验数据结构:校验返回的数据结构是否符合文档定义,自动发现接口数据异常。
- 可视化的断言、提取变量、数据库(SQL)操作等功能。
- 支持接口用例功能(一个接口多个用例)。
1)录入文档
2)API调试
这里分别有一个GET和POST请求的接口,让我们运行调试下吧
这个效果其实就是我们在使用postman等接口调试工具时的效果,不过从界面的可视化效果来说更加舒服护眼
3、API 自动化测试
- 完善的 API 场景测试(流程测试)功能,保证接口数据的正确性。
- 可视化的断言、提取变量、数据库(SQL)操作等功能。
- 支持自定义前置/后置脚本,自动校验数据正确性。脚本语法 100% 兼容 Postman,降低学习成本。
- 支持调用 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等语言代码。
有了 Apifox,再也不用为 Jemter上模拟并发接口测试的繁琐的配置感到焦虑了,只需要在界面上点点按钮,就可以将录入的API接口倒入到测试用例中做接口的并发测试了
4、API 数据 Mock
- 零配置即可 mock 出非常人性化的数据(根据 API 文档智能 mock)。
- 内置 Mock.js 规则引擎,非常方便 mock 出各种数据,并支持定义数据结构时设置 mock 规则。
- 支持根据不同参数值返回不同数据内容。
5、CI 持续集成
- 支持命令行方式运行 API 测试 (Apifox CLI)。
- 支持集成 Jenkins 等持续集成工具。
6、数据库操作
- 支持读取数据库数据,作为 API 请求参数使用。
- 支持读取数据库数据,用来校验(断言) API 请求是否成功。
7、自动生成代码
- 根据接口/模型定义,自动生成各种语言/框架的业务代码和 API 请求代码。
- 支持 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 种语言及框架。
- 支持自定义代码模板,自动生成符合自己团队的架构规范的代码,满足各种个性化的需求。
8、支持 HTTP、TCP、RPC
- 支持 HTTP(s) 接口管理。
- 支持 Socket (TCP) 接口管理。
- 后续将会支持 GraphQL、Dubbo、gRPC、WebSocket 等协议接口。
9、数据导入/导出
- 支持导出 OpenAPI (Swagger)、Markdown、Html 等数据格式。
- 支持导入 OpenAPI (Swagger)、Postman、HAR、RAP2、JMeter、YApi、Eolinker、NEI、RAML、DOClever 、Apizza 、DOCWAY、ShowDoc、apiDoc、I/O Docs、WADL、Google Discovery 等数据格式。
1)接口数据导出
在服务端开发完成后,有时候需要将API文档导出,以供他人或第三方使用,使用 Apifox提供的导出功能就很方便了,只需要定位到具体的API,点击导出就OK了
然后根据自身的偏好导出一种特定格式的接口文档即可
2)接口数据导入
我们先从postman里面导出一个api接口
3)导入验证
然后在Apifox中测试下导入功能吧,点击导入
下面会看到,Apifox支持可导入的文件类型还是非常丰富的,这里我们选择 postman导出的API文件
执行导入,点击确认导入
通过上面的操作可以看到,外部的接口就成功导入进来了,是不是非常简单,这对于后续需要从其他API工具转向Apifox的同学来说,工具使用的切换成本也降低了。
10、团队协作
- 接口数据云端同步,实时更新。
- 成熟的团队/项目权限管理,支持管理员、普通成员、只读成员等角色设置,满足各类企业的需求。
1)团队管理
该功能相当于说,一个部门,或者一个产品开发组内的小伙伴们就可以加入到这个项目组,就有权限使用里面的接口了,对于技术团队的管理者来说,可以对API层面进行权限相关的操作管理了,比如给API项目组添加新成员,设置相关的角色权限等。
四、解锁Apifox使用的最佳姿态
小编在使用了Apifox之后,结合自身在实践过程中对各类API工具的使用,以及对于Apifox这款新生代代API工具的使用体验来说,还是很值得推荐的,具体到使用时,给出如下几点建议:
- 团队管理者,比如技术经理,内部召开API评审,初步定出本次涉及到的API列表;
- 创建项目(建议提前划分不同的环境,开发,测试,生产),根据Apifox文档定义规范定义并录入上面定好的API接口到Apifox;
- 后端开发完毕API之后,使用Apifox进行API接口自测;
- 前端人员在Apifox上面进行接口调试或测试,如果后端接口未出来,前端可以使用Apifox的数据mock功能进行联调;
- 后端接口调试完毕后,测试人员可以同步参与进行接口用例的测试;
- 前后端联调完毕后,将环境从开发切换到测试的数据进行完整的功能测试;
- 如果团队内部的开发人员涉及到远程开发,可以通过API分享或者上传云端进行接口对接和联调;
- 全部功能联调完毕,及时的将本次的API接口从Apifox导出存档,方便后续查阅和追溯;
五、Apifox下载地址
上面详细的介绍了Apifox从安装到使用的全部流程,对于这款了解国内程序员使用习惯的API工具来说,算是一款比较用心,且堪称良心的产品了,而且下载免费,上手几乎零成本,期待Apifox越做越好,让我们拭目以待吧,有兴趣和需要的小伙伴门,可以去官网 详细了解。