后端怎么把API提供出去?后续有修改怎么办?

eoLinker 技术开发  2021-08-24 17:44:23

今天我们来聊一聊,后端同学如何高效地提供API给其他同事,以及需要修改了怎么处理。

相信基本都知道需要接口文档来解决。

有的人会使用markdown将接口写下来,相关负责人约定好一个固定的模板,这就是可以使用的文档了。当然其他格式也有,word和txt都可以,还有什么不行呢哈哈。

但是有的同学可能连一点文档资料都不输出,这样的就不大行了,换成在电视剧里,这样的就是大反派了。

 

那么测试的时候呢?

大多数人可能使用的是postman工具,对照着接口进行参数的设置,进行自测,或者写脚本进行测试。

不过这样都太麻烦了,还要画太多的时间在书写接口上面,每次修改接口还要对应的修改文档,相当繁琐。

来,看看Eolinker是如何解决上述问题的吧。

 

Eolinker是什么

Eolinker是国内最大的接口生命周期管理的工具,可以直接将接口数据转换成API文档。

 

那Eolinker对比其他同类的自动生成接口文档工具有什么优势呢?

一是形式灵活。Eolinker不仅支持手动创建文档规范接口用例,也支持直接导入如Swagger上的接口数据来生成文档。API数据需要改动的话,可以改完了一键更新接口文档,既避免了接口文档混乱的尴尬,也方便查看更新历史随时回调。

 

二是功能完善。Eolinker写好接口文档后可以直接进行接口测试和后续的开发,不用特地换回postman等工具,出了问题也可以直接找到客服团队。退一万步不用的话,也可以随时导出多种格式的接口文档。

 

呐,测试成功

如果将这样的文档给出去,对前端来说就非常的友好了,并且我们的工作量也没有什么增加,注释都省了好多。

感兴趣的朋友可以直接去在线使用看看,有Eolinker账号就可以用了。

使用地址:www.eolinker.com

...全文
563 点赞 收藏 回复
写回复
回复
切换为时间正序
请发表友善的回复…
发表回复

还没有回复,快来抢沙发~

相关推荐
发帖
API及云原生
创建于2021-06-07

160

社区成员

API接口以及云原生相关如容器、微服务等内容的讨论
帖子事件
创建了帖子
2021-08-24 17:44
社区公告
暂无公告