文档工具- 利用Swagger反向工程输出API接文档

背景

文档与设计正常的流程是：服务接口文档 ->服务设计开发。但是，经常性的接口有改动，开发人员不会再去修改文档，导致接口与文档对应不上。
当然，真正的原因是领导要检查项目产出。需要使用反向工程快速输出文档。

因为Api的数量有点大（有500多个），并且这种事情基本上每个项目都要做一次。那就整个工具快速导出吧。

流程

获取swagger ApiDoc

点击以下图所示链接，获了ApiDoc报文。

Api 报文如下，有点长，我们先把它复杂出来。

工具使用

1：工具是使用SpringMVC开发的一个接口。使用Swagger-ui打开。

2：把Api报文贴进去。点击 Execute 按钮。

3:Execute之后，会有一个下载链接。点击后下载excel。

4:打开excel。

5：根据喜好，设置样式 （代码也有配置样式 ，因代兼容有点问题 ，我把它全部注释掉了）。

项目的API导出来有2000多行，估计手工做的话，会疯掉。。

源代码（分享git）,代码很简单，很小，可以根据自己的喜好调整 。

https://github.com/RichyLiu0/ProductTools.git