上次分享我使用 eolinker 的一些心得和感受后,很高兴获得大家的关注,其实对于我而言,我更愿意把好用的工具分享给大家,用我的亲身经历来推荐更真实一点。如果有什么值得我去推荐的工具,也欢迎大家留言告诉我,我去了解看看。
“这里,你改一下,这里返回一个 object。” “好。。。” “还有这里,返回个 String。” 。。。。。。 在接口文档改了 7、8 个 version 后,组长又发话了,“我觉得还是先前第 2 个版本的参数描述和说明更直观一点,你改回来吧。” “额。。。。。。第二个版本的参数是怎么写来着。。。。。。”
已经不止一次遇到这样的情况了,代码不断更新迭代,接口文档同时根据代码变动和进行细节上的改动,在改动多次后又倒退回原来的版本。
虽说实践出真知,但如果先前的文档可以保存,根据讨论来进行接口文档版本切换。。。那就更好了。。。
现在公司抛弃了传统的文档编写接口文档的方式,采用在线接口管理平台 eoLinker ( https://www.eolinker.com )录入接口信息。eoLinker 对 api 接口提供版本管理功能,清晰记录了接口修改的动态,还可以进行一键化接口回滚。
1、可以通过设置接口状态来区分接口,接口状态分为启用、维护和弃用
接口列表一览
修改后点击保存,填入更新描述,记录接口修改描述。
2、选择“历史”,获取最近十条接口修改历史,接口历史清晰可见。
选择需要切换的接口历史,便可一键切换
切换前
切换后
如果使用 eoLinker 进行接口版本管理,机械重复的工作就没必要再做了,要切换回之前的接口版本,只需要点击切换即可。是不是管理版本都方便了很多?
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.