swagger文档转html

最新推荐文章于 2025-02-21 15:09:29 发布

Cecil_X

最新推荐文章于 2025-02-21 15:09:29 发布

阅读量1k

点赞数

分类专栏：开发工具文章标签： swagger2 html java maven

本文链接：https://blog.csdn.net/Cecil_X/article/details/119359406

版权

本文档介绍如何将 Swagger JSON API 转换为 HTML 文件，适用于将 Swagger 文档用于外部接口文档。通过创建 Maven 项目，添加特定依赖，并执行转换命令，可以将 Swagger 输入转换为 HTML。注意解决生成的 HTML 中链接问题，确保路径和定义间的跳转正常。参考了 Swagger2Markup 官方文档及腾讯开发者文章。

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

swagger文档在开发时是一个很大的助力，但是在对外提供接口文档时就不是很灵活。

这里记录一下从swagger文档转html的方法(还能转pdf，暂时用不上)。

先建立一个空的maven项目，在pom中添加

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <file_encoding>UTF-8</file_encoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!--此处填要生成文档的swagger2 json api地址-->
                    <swaggerInput>http://localhost:8081/v2/api-docs?group=0.1%E7%89%88</swaggerInput