前言

• 若依(ruoyi)： v4.3

若依自帶了 swagger 的接口。
將若依啟動(dòng)后，訪問 http://localhost/swagger-ui.html （或者使用菜單系統(tǒng)工具 -> 系統(tǒng)接口）可以查看接口。

將若依啟動(dòng)后，訪問 http://localhost/v2/api-docs 可以查看 json 格式的接口文檔。

一切都很不錯(cuò)，只是要有個(gè) html 或 pdf 格式的接口文檔就更好了。

更好的 html 或 pdf 格式的接口文檔

要生成更好的 html 或 pdf 格式的接口文檔需要用到 swagger2pdf 項(xiàng)目。

生成的步驟是這樣的：

將 http://localhost/v2/api-docs 的json格式接口文檔，利用 Swagger2Markup Maven插件生成 asciidoc 格式的文檔。

利用asciidoctor Maven插件生成 html 和 pdf 文件。

操作

克隆項(xiàng)目 https://gitee.com/sayyy/swagger2pdf

將 http://localhost/v2/api-docs 另存為 swagger.json

替換 swagger2pdf/src/test/resources 目錄下的 swagger.json

在 swagger2pdf 目錄下執(zhí)行命令：mvn clean test

在swagger2pdf/target/asciidoc目錄找到 html/pdf 格式的接口文檔

結(jié)果展示

參考

https://github.com/Swagger2Markup/spring-swagger2markup-demo
https://leongfeng.github.io/2017/02/20/springboot-springfox-swagger2markup-spring-restdoc/

https://gitee.com/nitianziluli/swagger2pdf
https://github.com/nitianziluli/swagger2pdf
https://blog.csdn.net/u013719669/article/details/80998225

總結(jié)

以上是生活随笔為你收集整理的【若依(ruoyi)】swagger 生成接口文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。