java微服务下的接口文档该如何管理

接口文档的发展

技术的快速迭代,使得服务的架构快速变化,文档工具也跟着服务的升级经历了以下阶段:

  1. 前后端不分离的单体服务,不需要文档阶段
  2. 前后端分离的单体服务,手写文档阶段
  3. 微服务下Swagger、Openapi为主流的文档生成工具

主流文档工具的弊端

然而随着近年来微服务的热度日渐高涨,许许多多的公司进入都开始进行微服务的转型。越来越多的公司加入更加促进了微服务框架的快速迭代。慢慢的Swagger、Openapi为主流的文档工具就缺陷就体现了出来:

    学习成本高 耗时 功能单一

什么才是我们需要的

那么有什么更好的办法去解决呢?我们的诉求又是什么,经过长时间思考我得到以下结论:

    安全,如今的微服务发展已经不仅限于对外的接口,还有服务和服务之间的接口,安全的问题自然不言而喻。 学习成本低 便捷,快速 包含mock,请求,文档,等功能,需要强大且易扩展 集中,微服务下的文档集中可以让我们加快速的了解到那些接口是对外,那些是对内,且同时可以了解到当前接口是那些服务调用了。以便于我们后期维护 兼容,微服务的快速发展,让世面上产生了很多种不同的框架,许多时候,不同的项目都是不同的 框架构成。 零侵入,Swagger、Openapi侵入性不言而喻,当我们不再使用其中一个框架作为文档工具,或者产生新的需求时,我们往往无法进行文档的重构,繁重的任务会压垮所有开发者。 满足如此之多的需求。 那么满足如此之多的需求,该如何才能解决呢,或者说,是否已经有了已经出现的技术去完成这项工作?答案是显而易见的

新一代的接口文档管理工具

Idea插件 Restful Cloud +Torna

Restful Cloud 提供了那些功能

接口地址的搜索(快捷键Ctrl+Q)

导出,上传,重命名

不同项目的筛选

扩展

Restful Cloud 使用了Sqlite文件型数据库缓存了所有已经加载过项目的api。并且所有的配置和接口信息都内置在sqlite表中,所以可以更加方便和快捷的进行不同注解以及不同平台搜索的扩展。

经验分享 程序员 微信小程序 职场和发展