共计 1940 个字符,预计需要花费 5 分钟才能阅读完成。
github 上有 maven 开源插件 swagger2markup 将 swagger 文档转为.adoc 格式的文档,另外一个 maven 开源插件 asciidoctorj-pdf 则可以将.adoc 格式的文档转为 html 和 pdf。由于 GitHub 访问不稳定,在 gitee 上有镜像项目。所以我就贴 gitee 上的项目地址了。
实现从 swagger 文档转为 html 或 pdf 的项目有两个。一个一个说
一、第一个 gitee 地址:https://gitee.com/why_are_you_so_seriously/swagger2markup-maven-project-template.git
这个项目 src 中没有 Java 代码,纯插件的。
使用注意以下几点即可:
1、将 pom 中将插件仓库中两个仓库的 url 改为阿里云的仓库地址
pluginRepositories>
pluginRepository>
id>jcenter-snapshots/id>
name>jcenter/name>
url>http://maven.aliyun.com/nexus/content/groups/public//url>
/pluginRepository>
pluginRepository>
snapshots>
enabled>false/enabled>
/snapshots>
id>jcenter-releases/id>
name>jcenter/name>
url>http://maven.aliyun.com/nexus/content/groups/public//url>
/pluginRepository>
/pluginRepositories>
2、将 标签中的值改为要转换的 swagger 文档的 json 格式或者 api-doc 的网址
3、swagger2markup 插件的配置中增加中文
4、增加中文字体
用解压工具 J 将 asciidoctorj-pdf jar 包打开(是打开不是解压),进入 gemsasciifontsdoctor-pdf-1.5.0.alpha.15data 这一级,打开 fonts 文件夹,将中文字体放进去,再打开 themes 文件夹,将 default-them.yml 文件中 mplus1p 开头的字体替换为中文字体。字体 4 种是一套的,常规,加粗,斜体,加粗带斜体。下载页面地址 https://download.csdn.net/download/diyangxia/19266310?spm=1001.2101.3001.6661.1&utm_medium=distribute.pc_relevant_t0.none-task-download-2~default~CTRLIST~Paid-1-19266310-blog-43563085.235^v43^pc_blog_bottom_relevance_base4&depth_1-utm_source=distribute.pc_relevant_t0.none-task-download-2~default~CTRLIST~Paid-1-19266310-blog-43563085.235^v43^pc_blog_bottom_relevance_base4&utm_relevant_index=1
执行命令 mvn clean package 或者点击 idea 中的 maven 工具打包 就会生成 pdf 文档和 html 文档
二、第二个 gitee 地址:https://gitee.com/leeBingbing/spring-swagger2markup-demo.git
这个项目有源代码,是一个演示怎么把 swagger2markup 功能集成到项目中的,项目打包后会生成 pdf 和 html 格式的文档,项目运行起来后,还可以访问在线的 pdf 文档和 HTML 文档。需要注意以下几点:
1、将 pom 中将插件仓库中两个仓库的 url 改为阿里云的仓库地址,跟上个项目一样
2、将 标签中的值改为要转换的 swagger 文档的 json 格式或者 api-doc 的网址跟上个项目一样
3、swagger2markup 插件的配置中增加中文,跟上个项目一样
4、增加中文字体,跟上个项目一样
执行命令 mvn clean package 或者点击 idea 中的 maven 工具打包 就会生成 pdf 文档和 html 文档,
java -jar 运行 jar 包,
浏览器中输入 http://localhost:9080/docs/index.html 就能访问在线的 html 文档
浏览器中输入 http://localhost:9080/docs/index.pdf 就能访问在线的 pdf 文档
原文地址: 使用插件将 swagger 文档转 html 或 pdf