Swagger UI 导出文档从入门到实战指南
作者：jitanler
1. 引言
Swagger UI 是 OpenAPI 规范（原 Swagger 规范）最流行的可视化工具之一，它能够将接口定义文件渲染成交互式的 API 文档页面。在实际开发中，我们经常需要将 Swagger UI 中的接口文档导出为离线文档、PDF 或 Markdown 文件，用于团队协作、客户交付或知识沉淀。本文将围绕 Swagger UI 导出文档这一主题，介绍多种导出方案，并提供丰富的代码实例，帮助你在不同场景下快速完成文档导出。
2. 准备工作
在开始导出之前，需要确保本地环境满足以下条件：
- 已安装 Java 8 或更高版本（用于运行 Swagger 相关工具）。
- 已安装 Node.js 12 及以上版本（用于运行 npm 生态的导出工具）。
- 已有一个可访问的 Swagger UI 页面或 OpenAPI 描述文件（如 swagger.json、openapi.yaml）。
下面是一个典型的 Spring Boot 项目集成 Swagger 的配置示例，用于生成 OpenAPI 描述文件。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("示例 API 文档")
.description("用于演示 Swagger UI 导出文档的示例项目")
.version("1.0.0")
.build();
}
}启动项目后，访问 http://localhost:8080/swagger-ui/index.html 即可看到 Swagger UI 页面，同时后端会暴露 /v3/api-docs 接口返回 OpenAPI JSON 数据。
3. 导出 OpenAPI 原始 JSON
导出文档的第一步通常是获取 OpenAPI 原始描述文件。Swagger UI 页面本身提供了下载入口，也可以通过命令行工具直接拉取。
3.1 通过 Swagger UI 页面下载
在 Swagger UI 页面右上角，点击「Explore」旁边的下拉菜单，选择「Download OpenAPI Specification」即可下载 JSON 文件。这种方式适合人工操作，但无法自动化。
3.2 通过 curl 命令拉取
在 CI/CD 流水线中，更推荐使用 curl 直接拉取 OpenAPI 描述文件：
curl -o swagger.json http://localhost:8080/v3/api-docs
如果接口需要认证，可以携带 Token：
curl -H "Authorization: Bearer YOUR_TOKEN" \
-o swagger.json \
http://localhost:8080/v3/api-docs拉取成功后，可以用 jq 工具快速校验 JSON 格式是否合法：
jq . swagger.json > /dev/null && echo "JSON 格式合法"
4. 使用 Swagger2Markup 导出 Markdown 和 AsciiDoc
Swagger2Markup 是一个 Java 库，可以将 OpenAPI 描述文件转换为 Markdown、AsciiDoc 或 Confluence 格式。它非常适合在 Maven 或 Gradle 构建流程中集成。
4.1 Maven 依赖配置
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.3</version>
</dependency>4.2 编写 Java 转换代码
import io.github.swagger2markup.GroupBy;
import io.github.swagger2markup.Language;
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.nio.file.Path;
import java.nio.file.Paths;
public class SwaggerToMarkdown {
public static void main(String[] args) throws Exception {
Path inputFile = Paths.get("swagger.json");
Path outputDir = Paths.get("docs");
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.MARKDOWN)
.withOutputLanguage(Language.ZH)
.withPathsGroupedBy(GroupBy.TAGS)
.withGeneratedExamples()
.build();
Swagger2MarkupConverter converter = Swagger2MarkupConverter
.from(inputFile)
.withConfig(config)
.build();
converter.toFolder(outputDir);
System.out.println("Markdown 文档已生成到: " + outputDir.toAbsolutePath());
}
}运行上述代码后，会在 docs 目录下生成多个 Markdown 文件，包括 overview.md、paths.md、definitions.md 等。
4.3 转换为 AsciiDoc
只需将 MarkupLanguage.MARKDOWN 替换为 MarkupLanguage.ASCIIDOC，即可输出 AsciiDoc 格式：
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.ASCIIDOC)
.withOutputLanguage(Language.ZH)
.build();5. 使用 widdershins 导出 Markdown
widdershins 是 Node.js 生态中非常流行的 OpenAPI 转 Markdown 工具，它生成的文档结构清晰，支持 OpenAPI 3.0 和 Swagger 2.0。
5.1 安装 widdershins
npm install -g widdershins
5.2 基本用法
widdershins --language zh \
--summary \
--omitHeader \
--search false \
swagger.json \
-o api-docs.md参数说明：
--language zh：指定输出语言为中文。--summary：只输出接口摘要，减少正文内容。--omitHeader：省略文档头部信息。--search false：关闭搜索功能。
5.3 在 Node.js 项目中以编程方式调用
const widdershins = require('widdershins');
const options = {
language: 'zh',
summary: true,
omitHeader: true,
search: false
};
widdershins.convert('swagger.json', options)
.then(markdown => {
const fs = require('fs');
fs.writeFileSync('api-docs.md', markdown);
console.log('Markdown 文档生成成功');
})
.catch(err => {
console.error('转换失败:', err);
process.exit(1);
});6. 使用 redoc-cli 导出 HTML 和 PDF
redoc-cli 是 ReDoc 官方提供的命令行工具，可以将 OpenAPI 描述文件打包成独立的 HTML 文件，也可以借助 headless 浏览器导出 PDF。
6.1 安装 redoc-cli
npm install -g redoc-cli
6.2 导出独立 HTML 文件
redoc-cli bundle swagger.json \
--options.theme.colors.primary.main=#1890ff \
--title "示例 API 文档" \
-o api-docs.html生成的 HTML 文件是自包含的，包含所有 CSS 和 JavaScript，可以直接通过浏览器打开，也可以部署到静态服务器。
6.3 导出 PDF 文件
redoc-cli bundle swagger.json \
--output api-docs.html \
--options.theme.colors.primary.main=#1890ff
npx --yes puppeteer print-to-pdf api-docs.html api-docs.pdf这里使用 Puppeteer 的 print-to-pdf 命令将 HTML 渲染为 PDF。如果 PDF 内容被截断，可以调整页面尺寸：
npx --yes puppeteer print-to-pdf \
--landscape \
--format A4 \
api-docs.html api-docs.pdf7. 使用 Swagger UI 自带打印功能导出 PDF
Swagger UI 页面本身支持浏览器打印，通过调整打印样式可以导出较为整洁的 PDF 文件。具体步骤如下：
- 在浏览器中打开 Swagger UI 页面。
- 按
Ctrl + P（Windows）或Command + P（Mac）打开打印对话框。 - 在「目标打印机」中选择「另存为 PDF」。
- 在「更多设置」中，将「纸张大小」设为 A4，「边距」设为「无」。
- 勾选「背景图形」选项，确保接口标签和颜色正常显示。
- 点击「保存」即可导出 PDF 文件。
这种方式的优点是无需额外安装工具，缺点是页面中的折叠面板默认只展示展开状态，需要手动展开所有接口后再打印。
8. 使用 OpenAPI Generator 导出多种格式
OpenAPI Generator 是一个功能强大的代码生成工具，除了生成客户端 SDK 和服务端骨架代码外，也可以生成 HTML 和 Markdown 格式的文档。
8.1 安装 OpenAPI Generator CLI
npm install -g @openapitools/openapi-generator-cli
8.2 生成 HTML 文档
openapi-generator-cli generate \
-i swagger.json \
-g html \
-o docs/html8.3 生成 Markdown 文档
openapi-generator-cli generate \
-i swagger.json \
-g markdown \
-o docs/markdown8.4 生成 Postman 集合
如果需要将接口导入 Postman 进行调试，可以使用 postman-collection 生成器：
openapi-generator-cli generate \
-i swagger.json \
-g postman-collection \
-o docs/postman9. 自动化导出脚本实战
在实际项目中，我们通常希望将导出过程集成到 CI/CD 流水线中。下面给出一个完整的 Shell 脚本示例，实现「拉取 OpenAPI 描述文件 → 生成 Markdown → 生成 HTML → 生成 PDF」的自动化流程。
#!/bin/bash
set -e
API_BASE_URL="${API_BASE_URL:-http://localhost:8080}"
OUTPUT_DIR="${OUTPUT_DIR:-./docs}"
TOKEN="${TOKEN:-}"
echo "开始导出 Swagger 文档..."
mkdir -p "$OUTPUT_DIR"
1. 拉取 OpenAPI 描述文件
echo "拉取 OpenAPI 描述文件..."
if [ -n "$TOKEN" ]; then
curl -H "Authorization: Bearer $TOKEN"
-o "$OUTPUT_DIR/swagger.json"
"$API_BASE_URL/v3/api-docs"
else
curl -o "$OUTPUT_DIR/swagger.json"
"$API_BASE_URL/v3/api-docs"
fi
2. 使用 widdershins 生成 Markdown
echo "生成 Markdown 文档..."
widdershins --language zh
--summary
--omitHeader
--search false
"$OUTPUT_DIR/swagger.json"
-o "$OUTPUT_DIR/api-docs.md"
3. 使用 redoc-cli 生成 HTML
echo "生成 HTML 文档..."
redoc-cli bundle "$OUTPUT_DIR/swagger.json"
--title "API 文档"
-o "$OUTPUT_DIR/api-docs.html"
4. 使用 Puppeteer 生成 PDF
echo "生成 PDF 文档..."
npx --yes puppeteer print-to-pdf
--landscape
--format A4
"$OUTPUT_DIR/api-docs.html"
"$OUTPUT_DIR/api-docs.pdf"
echo "文档导出完成，输出目录: $OUTPUT_DIR"
ls -lh "$OUTPUT_DIR"在 Jenkins 或 GitHub Actions 中，只需在构建步骤中调用该脚本即可。下面是一个 GitHub Actions 的示例片段：
name: Export API Docs
on:
push:
branches: [ main ]
jobs:
export-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm install -g widdershins redoc-cli
- run: chmod +x export-docs.sh
- run: ./export-docs.sh
env:
API_BASE_URL: https://api.example.com
TOKEN: ${{ secrets.API_TOKEN }}
- uses: actions/upload-artifact@v4
with:
name: api-docs
path: docs/10. 常见问题与解决方案
10.1 导出的 Markdown 中中文乱码
确保在转换时指定语言参数。使用 widdershins 时添加 --language zh，使用 Swagger2Markup 时设置 withOutputLanguage(Language.ZH)。同时确认源 OpenAPI 描述文件中的 description 字段使用 UTF-8 编码。
10.2 PDF 导出时内容被截断
这通常是因为页面宽度超出纸张范围。可以尝试使用横向布局（--landscape），或者调整 Puppeteer 的页面缩放比例：
npx --yes puppeteer print-to-pdf \
--landscape \
--format A4 \
--scale 0.8 \
api-docs.html api-docs.pdf10.3 接口需要登录认证
如果 Swagger UI 页面本身需要登录，可以在拉取 OpenAPI 描述文件时携带 Cookie 或 Token。对于 Swagger UI 页面内的接口调试认证，可以在页面右上角的 Authorize 按钮中配置，但这不影响文档导出。
10.4 导出的 HTML 文件过大
当接口数量较多时，生成的 HTML 文件可能达到几十 MB。可以通过 redoc-cli 的 --options.disableSearch 选项关闭搜索功能，减小文件体积：
redoc-cli bundle swagger.json \
--options.disableSearch \
-o api-docs.html11. 总结
本文介绍了多种 Swagger UI 导出文档的方案，从最简单的浏览器打印，到可集成 CI/CD 的自动化脚本，覆盖了 Markdown、HTML、PDF、AsciiDoc 和 Postman 集合等常见格式。在实际项目中，建议根据团队的技术栈和交付场景选择合适的方案：
- 需要离线交付或知识沉淀时，优先选择 Markdown 或 AsciiDoc。
- 需要对外发布在线文档时，使用 redoc-cli 生成独立 HTML。
- 需要打印或归档时，使用 Puppeteer 导出 PDF。
- 需要自动化集成时，将导出脚本接入 CI/CD 流水线。
希望本文的代码实例能够帮助你快速搭建起 Swagger 文档导出能力，提升接口文档的维护效率。
到此这篇关于Swagger UI 导出文档：从入门到实战的完整指南的文章就介绍到这了,更多相关Swagger UI 导出文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
您可能感兴趣的文章:
- SpringBoot整合Swagger页面禁止访问swagger-ui.html方式
- SpringBoot线上环境彻底关闭Swagger-UI的方式
- Springboot整合Swagger2后访问swagger-ui.html 404报错问题解决方案
- Swagger-boostrap-ui如何配置用户名密码访问
- springboot项目集成swagger-bootstrap-ui全过程
- SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解解读
- Springboot整合Swagger3全注解配置(springdoc-openapi-ui)
- Springboot下swagger-ui.html访问不到的解决方案
- Spring项目中swagger用法与swagger-ui使用
- springboot使用swagger-ui 2.10.5 有关版本更新带来的问题小结