在本人的职业生涯里,有用过swagger2来做API文档的,也有使用到rap2来自己手写API文档。但如果是手写API文档的话,会浪费很多的时间,会让开发周期变得更长并且写接口文档的人也会很烦躁,所以今天写这篇文章是我在实际工作中遇到的情况,在项目开发完成后,甲方需要一系列文档以交付项目。
- SwaggerToWord
GitHub地址:https://github.com/JMCuixy/swagger2word
拉取项目后,项目呈如此结构。
但我不知道是因为该项目很久没有维护的关系还是怎么回事。
这两个文件Impl的导包有问题,Controller有方法的异常没有抛出。但手动操作一下就好了
之后在yml文件里,配置你需要生成为word文档的swagger地址(swagger的Json地址,在swagger-ui的顶部)。
如下图:
启动项目访问配置里所配置的端口号的swagger-ui地址。如本人的是:localhost:8081/swagger-ui.html
以此点击框内内容,即可下载word文档