使用插件将swagger文档转html或pdf

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.input>标签中的值改为要转换的swagger文档的json格式或者api-doc的网址

在这里插入图片描述

3、swagger2markup插件的配置中增加中文

在这里插入图片描述

4、增加中文字体

用解压工具J将asciidoctorj-pdf jar包打开(是打开不是解压),进入gems\asciifontsdoctor-pdf-1.5.0.alpha.15\data\这一级,打开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%7Edefault%7ECTRLIST%7EPaid-1-19266310-blog-43563085.235%5Ev43%5Epc_blog_bottom_relevance_base4&depth_1-utm_source=distribute.pc_relevant_t0.none-task-download-2%7Edefault%7ECTRLIST%7EPaid-1-19266310-blog-43563085.235%5Ev43%5Epc_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.input>标签中的值改为要转换的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文档

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值