如何维护接口文档供外部调用——在线接口文档管理

上个章节初步将一个应用运行起来,由于服务不会单独存在,服务开发团队必然与其他服务团队进行服务调用,暴露出对外接口势在必行。早期做开发的时候,大家习惯于以 word 或 excel 的形式,但弊端显而易见,一旦接口发生变动,文档需要同步更新,遗憾的是很多接口已经更新,但文档都没有跟上,相信你也有过痛苦的经历。本文带领你认识几款接口文档管理工具,并实现本案例实践中用到的在线接口文档管理。

几款 API 工具介绍

我们迫切需要一个接口文档工具,能实时与系统接口保持同步,无须额外付出成本(资金成本、时间成本)最好。这里介绍几个开源的 API 工具,可以选择使用。

RAP2

官方地址:http://rap2.taobao.org/,早期称为 RAP ,阿里妈妈 MUX 团队出品,后面项目停止维护,转移至 RAP2 项目。

来自官网的介绍:RAP2 是时下流行的开发接口管理工具,通常用于前后端分离的开发模式中,共同约定接口,而 RAP2 可以根据约定的接口自动生成 Mock 数据、对后端接口进行校验,拥有较好的文档编写体验,支持复杂的 Mock 逻辑,为开发提供了便利。 RAP2 是参照 RAP1 第一代的基础上,使用 Node + React 重构了所有主要功能。

可以在线使用,也可以本地部署使用,本地部署有详细的步骤介绍,从部署手册来看,产品还是比较重的,环境依赖也比较多。部署

你可能感兴趣的:(Spring,Cloud,Alibaba,微服务开发实战)