自从我用了这个接口文档版本管理,我的组长多活了几年

时间:2022-06-12 08:54:23

“这里,你改一下,这里返回一个object。”

“好...好......”

“还有这里,返回个String。”

......

在接口文档改了7、8个version后,组长又发话了,“我觉得还是先前第2个版本的参数描述和说明更直观一点,你改回来吧。”

......

“额......第二个版本的参数是怎么写来着......”

嗯,我一个180的大汉,这一刻想一拳打死组长。

 

已经不止一次遇到这样的情况了,代码不断更新迭代,接口文档同时根据代码变动和进行细节上的改动,在改动多次后又倒退回原来的版本。虽说实践出真知,但如果先前的文档可以保存,根据讨论来进行接口文档版本切换...那就更好了...

 

现在公司终于抛弃了传统的文档编写接口文档的方式,采用在线接口管理平台eoLinker录入接口信息。eoLinker对api接口提供版本管理功能,清晰记录了接口修改的动态,还可以进行一键化接口回滚。

 

例如可以通过设置接口状态来区分接口,接口状态分为启用、维护和弃用

自从我用了这个接口文档版本管理,我的组长多活了几年


接口列表一览

自从我用了这个接口文档版本管理,我的组长多活了几年


修改后点击保存,填入更新描述,记录接口修改描述。

自从我用了这个接口文档版本管理,我的组长多活了几年


选择“历史”,获取最近十条接口修改历史,接口历史清晰可见。

自从我用了这个接口文档版本管理,我的组长多活了几年


选择需要切换的接口历史,便可一键切换

切换前

自从我用了这个接口文档版本管理,我的组长多活了几年

切换后

自从我用了这个接口文档版本管理,我的组长多活了几年

 自从我用了这个接口文档版本管理,我的组长多活了几年

自从使用eoLinker进行接口版本管理,机械重复的工作就没必要再做了,要切换回之前的接口版本,只需要点击切换即可。

现在我已经没有那种手刃组长的想法了,嗯,eoLinker让组长多活几年。