前后端不合已经是司空见惯的事情,后端被前端吐槽不写接口文档、不及时更新文档,被测试吐槽接口不通、都是Bug等;前端和测试被后端吐槽事多。
作为一个后端开发,对于这些矛盾我也有深刻的共鸣,因为曾经的自己也被深深地困扰过。
我在之前公司的时候,就是用Swagger写接口文档。很多要更新的需求堆在一起时,经常忘记维护接口文档,要不就是只能维护一部分。重点是维护成本太高,开发任务已经很紧急了,还得抽空给他们文档(反正我会),耽误开发进度,还出力不讨好。
而且,跟我经常对接的前端,联调时候不管是自己的问题还是接口的小问题都来找我,文档一不及时更新就会捅到老板那里,为此吵过好几次,后来我忍不了就离职了。
后来换工作后,新的团队会用Apipost管理接口。当时虽然没有现在这么多功能,但是能实时更新接口文档,对我来说已经是个很美丽的亮点了。修改了接口信息可以自动同步到分享出去的接口文档,重点是没有**前端催我更新文档就很舒服。
后来,因为前后端分离开发越来越流行,我们后端还没开发出接口就得把接口信息给到前端,所以需要提前设计接口。前不久看到Apipost升级了v7版本,更新了API设计功能,实现代码未写、文档先行。而且自己可以快速同步调试接口,不用像之前那样不同的工具换来换去,不仅麻烦还经常出错。
如今我也从「写文档多麻烦,口头对一下不就行了」、「老子这么忙,哪有空写文档」变成了「这是谁连文档都不写?」、「仔细看文档,别来烦老子」。
哦对了!同样作为后端开发,Apipost真正好用的地方不仅仅是实时同步的接口文档,在日常开发接口需要调试时也是非常好用的。
很多接口之间的数据依赖,在之前开发完接口调试的时候,都需要写代码进行调用和传递参数;用Apipost进行调试时,可以选择预、后执行脚本中对应的脚本,就能自动补齐代码,多省时啊!