V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
scarqin
V2EX  ›  程序员

讲一讲怎么妙用 eoLinker 对接口进行版本管理

  •  
  •   scarqin · 2017-11-09 10:16:54 +08:00 · 2466 次点击
    这是一个创建于 2555 天前的主题,其中的信息可能已经有所发展或是发生改变。

    上次分享我使用 eolinker 的一些心得和感受后,很高兴获得大家的关注,其实对于我而言,我更愿意把好用的工具分享给大家,用我的亲身经历来推荐更真实一点。如果有什么值得我去推荐的工具,也欢迎大家留言告诉我,我去了解看看。

    “这里,你改一下,这里返回一个 object。” “好。。。” “还有这里,返回个 String。” 。。。。。。 在接口文档改了 7、8 个 version 后,组长又发话了,“我觉得还是先前第 2 个版本的参数描述和说明更直观一点,你改回来吧。” “额。。。。。。第二个版本的参数是怎么写来着。。。。。。”

    已经不止一次遇到这样的情况了,代码不断更新迭代,接口文档同时根据代码变动和进行细节上的改动,在改动多次后又倒退回原来的版本。

    虽说实践出真知,但如果先前的文档可以保存,根据讨论来进行接口文档版本切换。。。那就更好了。。。

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

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

    1

    接口列表一览

    1

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

    1

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

    1

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

    切换前

    1

    切换后

    1

    1

    如果使用 eoLinker 进行接口版本管理,机械重复的工作就没必要再做了,要切换回之前的接口版本,只需要点击切换即可。是不是管理版本都方便了很多?

    1 条回复    2017-11-10 09:46:54 +08:00
    Charlesling
        1
    Charlesling  
       2017-11-10 09:46:54 +08:00
    版本的互相切换,最多可以有几个版本切换?
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1128 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 19:00 · PVG 03:00 · LAX 11:00 · JFK 14:00
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.