使用插件将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文档

相关推荐
AI刀刀20 小时前
Kimi 文档导出格式错乱、排版丢失、导出报错?AI 导出鸭一键智能适配,稳定输出规范 Word、PDF,高效解决各类导出难题
人工智能·pdf·word·ai导出鸭
Ai-_Man20 小时前
豆包智能体把对话批量导出为Word或PDF的正确顺序
人工智能·ai·小程序·pdf·word
SamChan9021 小时前
FastAPI+Celery+Redis搭建企业级PDF翻译异步任务系统
redis·后端·python·pdf·wpf·fastapi
SamChan902 天前
用Playwright端到端测试PDF翻译功能:Web自动化测试实战
前端·python·ai·pdf·wpf
AI英德西牛仔2 天前
千问导出 pdf 颜色不一样怎么办,选用 AI 导出鸭优化格式转换,多维度剖析千问内容 PDF 变色各类成因
人工智能·ai·chatgpt·pdf·deepseek·ai导出鸭
赵广陆3 天前
企业实战:主体识别
langchain·pdf·langgraph
AI英德西牛仔3 天前
豆包导出 pdf 颜色不一样怎么办,选用 AI 导出鸭优化文档导出,结合行业白皮书数据解析色彩失真成因
人工智能·ai·chatgpt·pdf·deepseek·ai导出鸭
薰珞婷紫小亭子3 天前
如何解决IEEE期刊LaTeX 模版编译pdf出现大空白的问题
经验分享·pdf
Hello-FPGA3 天前
AI 如何自动通过 PDF 原理图生成管脚映射
人工智能·fpga开发·pdf
阿部多瑞 ABU3 天前
告别手工核图:基于 .NET + MuPDFCore 的 CAD 等轴测 PDF 材料表提取与新旧版本对比实战
后端·算法·ui·pdf·c#