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

相关推荐
海带紫菜菠萝汤15 小时前
企业批量PDF翻译方案:从选型到部署的完整指南
人工智能·算法·pdf
蓝创工坊Blue Foundry16 小时前
发票、凭证和对账单怎么整理成 Excel?先定义字段,再逐项复核
pdf·ocr·excel·文心一言·paddlepaddle
求真学习18 小时前
字节跳动Dolphin-v2:数字 PDF 拆开读、拍照文档整页读,自建拍照文档集平均编辑距离较原始 Dolphin降低约 91%
pdf·ocr·pdf解析·字节跳动·文档解析·dolphin-v2
CodexDave18 小时前
Python 自动化接单实战(四):PDF 批量提取先识别文本层还是扫描件
python·pdf·自动化·ocr·python自动化·文档处理·pdf提取
爱昏羔2 天前
上篇:从PDF到向量库 — 物流行业RAG系统的知识库构建全解析
python·langchain·pdf·agent·rag
AI导出鸭PC端2 天前
手机deepseek怎么导出pdf AI导出鸭
人工智能·pdf
蓝创工坊Blue Foundry3 天前
PaddleOCR 本地部署教程:小模型 OCR 如何完成字段提取到 Excel
pdf·自动化·ocr·excel·paddlepaddle·paddle
蓝创工坊Blue Foundry3 天前
个人藏书太多怎么整理?用 OCR 字段提取汇总成电子书目
pdf·ocr·excel·文心一言·paddlepaddle·paddle
蓝创工坊Blue Foundry4 天前
扫描件批量转 Excel:先确认要整表还原还是字段汇总
python·pdf·ocr·excel
审小匠OpenCPAi5 天前
审计票据与财报 PDF 怎么识别?通用 OCR、表格结构识别与多模态大模型的精度对比
pdf·ocr·审计