在前后端分离的开发模式下,前后端往往需要接口文档来进行交互。
用传统的文档写接口时,由于需求经常变动,接口文档也会随之变动。一开始,某接口信息已经写入文档,但后期因为需求变动,发现这个接口是多余的,便将其删除保存,后面产品经理多次修改需求后,觉得这个需求是有必要的,又叫我们重新录入,搞事情啊这是。嘿嘿,你知道上一个产品经理是怎么死的吗?不过自从项目组用 eoLinker 来进行接口管理后,这个问题也就没有再出现过了。
鄙人不才,就此记录下利用 eoLinker 进行 api 接口管理的技巧。
1、接口状态可设置,可选状态为启用、维护、弃用;
通过设置接口状态,浏览接口列表时,接口状态信息一目了然,绿色表示启用,橙色表示维护,灰色表示弃用。
2、删除后的接口进入接口回收站,避免误删操作,方便后期恢复接口;
3、导出接口文档时,接口回收站接口不会导出;
这是我比较喜欢的功能之一,不用的接口放入回收站,导出的接口文档不包含这些接口,交接时需要交接口文档的话就不用担心有冗余无用的信息,需要用到的时候又可以从接口回收站恢复再导出,保证接口文档的准确性。API 接口文档是自动生成的,这就不需要人工检查这么麻烦。
4、接口内容相似时,可将接口复制,提高接口复用率; 进入接口详情页面,点击“另存为(复制)”,修改部分接口信息,点击保存。
5、可对接口列表进行排序,可针对创建时间、更新时间、接口名称和星标进行排序,浏览时更加直观清晰。