背景:后端为了能保证前端可以快速接入,在开发早期就要提供接口API文档,我们使用swagger管理起来的。但因为接口文档给出的过早,无法保证后面不去变更,这样会产生几个问题
1、接口文档的变更通知不到位,一个接口文档的变更涉及到通知前端,还有对应的微服务。
2、接口修改(VPN到公司IP),只能通过人肉通知,并把对应的接口文档地址发给对方,告诉对方改了哪几个地方,看起来十分不方便。
因此,我这边查阅了几个关于API接口管理的工具,总结了以下几个关键。
1、要有通知机制,一个接口的修改,要通知到订阅方。
2、要有API上传文档的接口,若你的文档修改了,需要马上上传。这块最好的方法是自己写轮询抓接口文档地址,然后自动做上传更新。
3、有订阅功能,谁需要哪个接口,需要订阅的,维护自己的订阅list。
4、有历史功能,一个接口被改了几次、内容、操作人,都要记录下来。
5、搜索功能,能全局搜索所有接口。
以上,是我这对这个系统的一个初步的设计,因为目前为止,这个问题并没有恶化到一定程度,这个事情暂时记录下来,后续进行进一步跟踪。
网友评论