如何维护接口文档供外部调用—

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

几款 API 工具介绍

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

RAP2

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

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

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

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

十三种技术文档模板_在线文档，知多少？
不知大家有没有在线编辑文档的习惯在线编辑文档有许多好处比如:多平台同步.协作编辑等今天给大家推荐三款在线文档软件 -- 金山文档.腾讯文档.石墨文档限于篇幅,这里仅介绍它们对应的 Window ...
SpringBoot集成knif4j创建在线API文档
一直以来能够创建一个同项目一起发布的在线文档,曾经是很多程序员的梦想,偶然发现这个工具已经有了,测试之后发现还挺好用的,特地纪念. 这个工具就是knife4j,它是为Java MVC框架集成Swagg ...
在线协作文档综合评测：金山文档、腾讯文档、石墨文档
在线协作文档综合评测 :Notion.FlowUs.Wolai.飞书.语雀.微软 Office.谷歌文档.金山文档.腾讯文档.石墨文档.Dropbox Paper.坚果云文档.百度网盘在线文档如今, ...
在线蚂蚁文,菊花文生成工具
在线蚂蚁文,菊花文生成工具在线蚂蚁文,菊花文生成工具菊花体文字是目前网络上流行的神奇文字的一种,又称为蚂蚁文,其特点在保证正常阅读的前提下,增加了一些有趣的修饰,如边框.菊点等 https://t ...
在线火星文转简体中文工具
在线火星文转简体中文工具在线火星文转简体中文工具火星文(火星文:焱暒妏),趣味地意指地球人看不懂的文字,由符号.繁体字.日文.韩文.冷僻字或汉字拆分后的部分等非正规化文字符号组合而成. https ...
python 接口自动化测试框架有哪些_Python接口自动化测试框架
Python接口自动化测试框架在自动化的测试体系中,包含了UI自动化测试和接口自动化测试,UI自动化实现的前提是软件版本进入稳定期,UI界面稳定.变动少,相比较之下接口自动化,接口受外界因素的影响较 ...
SpringBoot 使用Swagger2打造在线接口文档（附源代码）
点击上方"好好学java",选择"置顶公众号" 优秀学习资源.干货第一时间送达! 精彩内容 java实战练习项目教程 2018微服务资源springboot.s ...
SpringBoot集成swagger生成在线接口文档
SpringBoot集成swagger生成在线接口文档集成maven依赖 <dependency><groupId>io.springfox</groupId>& ...
014-Axios Ajax：前后端分离概述，发送json类型的参数，前后端分离开发：在线接口文档，前端工程化、Element、nginx
第一节 Ajax概述 1.概述概念: Asynchronous JavaScript And XML,异步的JavaScript和XML. 作用: 数据交换:通过Ajax可以给服务器发送请求,并获取 ...

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

几款 API 工具介绍

RAP2

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

最新文章

热门文章