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