Swagger2之在线文档生成PDF和HTML文件

最新推荐文章于 2024-06-20 16:22:10 发布

jiandequn

最新推荐文章于 2024-06-20 16:22:10 发布

阅读量1.9k

点赞数

分类专栏： java swagger

本文链接：https://blog.youkuaiyun.com/jiandequn/article/details/94720045

版权

本文档介绍了如何使用Swagger2Markup在Maven环境中生成PDF和HTML文件。首先，需要添加Swagger2Markup依赖到pom.xml，然后配置Maven插件。通过执行特定的Maven命令，如`mvn swagger2markup:convertSwagger2markup`生成.adoc文件，再运行`mvn generate-resources`以生成HTML和PDF文档。在IDEA中，也可用Maven插件执行生成步骤，但可能只支持.adoc文件且存在异常情况。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

上章讲的swagger的配置（详细见：https://blog.youkuaiyun.com/jiandequn/article/details/94718957）；本章就开始pdf和html文件的生成。废话不多说了，直接开始配置；

1、maven的swagger2markup依赖(pom.xml)

 <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup</artifactId>
            <version>1.3.3</version>
        </dependency>

2、maven的插件(pom.xml)

 <plugins>
            <plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!--此处定要是当前项目启动所用的端口-->
                    <swaggerInput>http://localhost:8888/v2/api-do