一. Apifox简介
Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。
功能定位 Postman + Swagger + Mock + JMeter。
Apifox主要用于接口管理、开发、测试全流程集成工具,使用受众为整个研发技术团队,主要使用者为前端开发、后端开发和测试人员。而且公网SaaS版本完全免费。
二. 背景需求
1、概述
目前市面上很多团队都有前端后端测试三个岗位,当一个团队在开始开发一个项目前,前端与后端需要提前约定好接口,一般会安排一名开发工程师去编写一个API文档,通常会使用Swagger,此时后端会根据API文档去编写接口,而调试的时候则需要通过先前的文档再到Postman里面重新定义。
与此同时,在后端把接口做出来之前,前端如果想要提前开始开发的话,他又需要提前去Mock数据,他又要重新在Mock.js里写一遍接口定义。
测试则需要按照文档去Jmeter中去编写测试用例。而且在开发过程中也常会出现接口变更,此时还要同时改变Swagger、Postman、Mock、Jmeter里的定义,或者前后端联调的时候也常常会出现前后端数据类型不同的情况,而测试在最终对接口测试的时候也可能会出现实际返回值与文档不一致。整个开发团队的协同因此非常低效。
既然整个开发团队都是围绕API进行开发,但是现在的开发工作被分散在不同的开发工具上,Apifox的开发人员为解决上述痛点,因此便推出了Apifox
Apifox支持团队开发,开发团队可以同时工作,当API定义人员在Apifox上定义接口后,会实时同步给所有的团队成员。
同时Apifox还提供了更丰富的基于API的开发包
2、解决的问题
-
一套系统、一份数据,解决多个系统之间的数据同步问题。
-
只要定义好接口文档,接口调试、数据 Mock、接口测试即可直接使用,无需再次定义。
-
接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。
-
高效、及时、准确!
3、最佳实践
-
前端(或后端):在 Apifox 上定好接口文档初稿。
-
前后端:一起评审、完善接口文档,定好接口用例。
-
前端:使用系统根据接口文档自动生成的 Mock 数据进入开发,无需手写 mock 规则。
-
后端:使用接口用例 调试开发中接口,只要所有接口用例调试通过,接口就开发完成了。如开发过中接口有变化,调试的时候就自动更新了文档,零成本的保障了接口维护的及时性。
-
后端:每次调试完一个功