作为后端开发,我们通常需要维护API文档,调试API接口,有时需要Mock数据。虽然Postman作为接口调试工具非常好用,但不适合维护API文档。今天推荐一款功能更强大的工具Apifox,足以满足我们对API的各种需求,希望对大家有所帮助。
Apifox简介
Apifox定位为Postman+Swager+Mock+JMeter,具有API文档管理、API调试、APIMock、API自动化测试等功能。以前使用多种工具的数据同步问题可以通过一种工具来解决。高效、及时、准确!
安装
Apifox的安装非常方便,可以直接下载安装包解压安装,下载地址:http://www.apifox.cn/
官方非常贴心地提供了示例项目,直接打开体验Apifox功能,看界面还是很漂亮的;
如果我们自己使用它,我们首先需要建立一个新的团队,以促进团队成员之间的合作。
然后在团队中新建项目,我们可以在新建成功后开始使用Apifox的强大功能!
API文档导入
Apifox的API文档导入功能非常强大,支持Swager、Postman、Yapi、Showdoc等多达20种工具的导入。接下来,我们通过使用mall-tiny-swager项目中的接口来体验其导入功能!
首先,我们选择新的接口按钮和导入;
然后打开导入界面,选择Swager->URL导入,输入Swager数据URL;
Apifox将显示导入预览,显示要导入的接口和数据模型,将我们的接口返回的物理类转换为数据模型进行重用;
导入成功后,界面效果如下,Apifox区分了查看文档和修改文档,方便我们管理接口文档。
接口管理
看Apifox的请求参数界面,非常详细
看Apifox返回结果界面,支持折叠,这是很多工具没有的;
看Apifox修改的文档界面,支持添加状态、分组和标签。
接口调试
让我们体验一下Apifox的调试功能,比Postman更强大!
当我们开发接口时,我们经常需要分不同的环境。Apifox默认分了测试环境、正式环境和Mock服务。这三个基本上就足够了;
在调试接口之前,我们必须设置与环境对应的前URL。例如,我们在这里设置了测试环境;
在Apifox中我们可以使用接口用例来调试我们的接口,接口用例可以保存我们输入的参数,以便之后测试使用;
此时,我们输入错误的密码来调用下接口,断言将直接提示我们的结果与预期不一致;
有些接口我们需要传入Authorization头才能访问;
我们可以通过环境变量实现这种访问。首先,在登录接口中添加后置操作,选择提取变量,将返回的token提取到环境变量AUTH_TOKEN中;
然后修改接口文档,在Header中设置需要传入Authorization头;
接下来在接口用例中通过表达式使用Authorization头即可正常访问需要登录认证的接口了。
使用脚本
Apifox的自定义前后操作非常强大,不仅支持简单的断言和提取变量,还支持编写JS脚本。
比如我们之前判断操作成功,断言code等于200可以用脚本实现;
比如我们之前判断操作成功,断言code等于200可以用脚本实现;
此时,我们输入错误的密码来调用下一个接口,断言将直接表明结果与预期不一致。
Mock数据
当我们的后端接口没有开发完成,前端开发需要数据时,通常可以通过Mock提供数据,Apifox的Mock数据功能也非常强大。
Apifox声称可以根据您数据模型中的字段名称智能Mock,让我们来看看它的规则;
事实上,默认的Mock规则有时并不完善,比如我们来看看它的Mock数据;
此时,我们可以修改数据模型,使Mock数据更加人性化,例如,我们可以将各种状态设置为枚举类型;
也可以通过@image将logo字段设置为图片类型;
重新设置后,人性化多了;
接下来只需将环境改为Mock服务即可调用Mock数据接口!
测试管理
Apifox不仅可以支持接口调试,还可以创建批量测试和性能测试的测试用例。
首先,我们可以在测试管理中创建测试用例;
之后选择从接口用例导入,选择好需要导入的接口用例;
选择好运行环境后,点击运行进行批量测试;
测试完成后即可显示测试报告;
如果你想进行性能测试的话,在测试界面选择好线程数即可;
测试完成后,可通过导出报告查看更详细的报告信息。
主题设置
个人比较习惯深色主题,Apifox也可以选择亮色主题和主色的,可以直接在设置中切换。
总结
Apifox确实是一款界面美观、功能强大的API接口工具。Postman基本具有接口调试功能,还集成了接口文档管理、数据Mock、自动化测试等功能。强烈建议你试试!