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

要使用插件将Swagger文档转换为HTML或PDF,你可以使用swagger2markup工具。以下是如何将Swagger文档转换为HTML和PDF的步骤和示例代码:

  1. 首先,确保你有一个Swagger定义文件,通常是一个JSON文件,可以是URL或本地路径。
  2. 使用swagger2markup工具生成HTML或PDF。你需要下载并添加swagger2markupasciidoctor的依赖到你的项目中。

以下是Maven的pom.xml中的依赖示例:




<dependencies>
    <dependency>
        <groupId>io.github.swagger2markup</groupId>
        <artifactId>swagger2markup</artifactId>
        <version>1.3.3</version>
    </dependency>
    <dependency>
        <groupId>org.asciidoctor</groupId>
        <artifactId>asciidoctorj</artifactId>
        <version>2.4.3</version>
    </dependency>
</dependencies>
  1. 使用以下Java代码生成HTML或PDF:



import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;
 
import java.net.URL;
 
public class SwaggerToHtmlPdfExample {
    public static void main(String[] args) throws Exception {
        // 定义Swagger文档的URL
        URL swaggerUrl = new URL("http://your-swagger-definition-url/v2/api-docs");
 
        // 设置输出路径
        String outputPath = "src/docs/asciidoc/generated";
 
        // 设置配置
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.EN)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();
 
        // 转换Swagger文档到HTML
        Swagger2MarkupConverter.from(swaggerUrl)
                .withConfig(config)
                .build()
                .toFolder(outputPath);
 
        // 转换Swagger文档到PDF
        Swagger2MarkupConverter.from(swaggerUrl)
                .withConfig(config)
                .build()
                .toPDF(outputPath + "/swagger.pdf");
    }
}

确保替换http://your-swagger-definition-url/v2/api-docs为你的实际Swagger定义URL。

以上代码会生成AsciiDoc格式的文件,然后你可以使用AsciiDoc工具链将其转换为HTML或PDF。

生成HTML:




asciidoctor -r asciidoctor-diagram -a toc=left -d book src/docs/asciidoc/generated/swagger.adoc

生成PDF:




asciidoctor-pdf -r asciidoctor-diagram -d book src/docs/asciidoc/generated/swagger.adoc -o src/docs/asciidoc/generated/swagger.pdf

请确保你有AsciiDoctor和AsciiDoctor P

none
最后修改于:2024年08月10日 13:08

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日