使用插件将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改为阿里云的仓库地址

java 复制代码
<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文档

相关推荐
一个处女座的程序猿5 小时前
LLMs之PDF:zeroX(一款PDF到Markdown 的视觉模型转换工具)的简介、安装和使用方法、案例应用之详细攻略
pdf·markdown·zerox
Dxy12393102165 小时前
python下载pdf
数据库·python·pdf
周亚鑫5 小时前
vue3 pdf base64转成文件流打开
前端·javascript·pdf
一名技术极客6 小时前
Vue2 doc、excel、pdf、ppt、txt、图片以及视频等在线预览
pdf·powerpoint·excel·文件在线预览
S. Dylan20 小时前
Edge浏览器打开PDF无法显示电子签章
edge·pdf
一马平川的大草原20 小时前
如何基于pdf2image实现pdf批量转换为图片
计算机视觉·pdf·文件拆分
m0_5945263020 小时前
Python批量合并多个PDF
java·python·pdf
hairenjing112320 小时前
将图片添加到 PDF 的 5 种方法
pdf
✿゚卡笨卡20 小时前
pdf 添加页眉页脚,获取前五页
java·pdf
blegn20 小时前
PDF编辑工具Adobe Acrobat DC 2023安装教程(附安装包)
pdf·办公软件·office