Swagger UI 页面导出为「永久离线文档」最全方法(2025最新,7种方式任选)
| 目标 | 推荐方式(从快到美) | 操作难度 | 输出格式 |
|---|---|---|---|
| 1. 快速导出 PDF(最常用) | 浏览器直接打印 → 另存为 PDF | ★☆☆☆☆ | |
| 2. 一键导出超漂亮 PDF | 用 Scalar 官方导出功能 | ★☆☆☆☆ | PDF(带目录、深色) |
| 3. 导出 Word(可编辑) | 打印 → 另存为 PDF → 转 Word | ★★☆☆☆ | DOCX |
| 4. 导出 Markdown | swagger-to-md 工具 | ★★☆☆☆ | MD |
| 5. 导出 HTML 离线包 | 静态托管页面直接打包 | ★☆☆☆☆ | 完整 HTML 包 |
| 6. 导出 Postman 集合 | Swagger UI → Postman 一键导入 | ★☆☆☆☆ | Postman Collection |
| 7. 最美企业级 PDF | 我给你现成的模板(带封面、水印、目录) | ☆☆☆☆☆ |
实战操作(每种 30 秒搞定)
- 最快最常用:浏览器直接打印 PDF(90%人都用这个)
打开你的 Swagger UI 页面 → 按 Ctrl+P(Mac: Cmd+P)
→ 目标选择「保存为 PDF」
→ 布局选「纵向」,页眉页脚关掉,背景图形勾上
→ 更多设置 → 纸张大小 A4,边距「最小」
→ 保存即可(效果已经很不错) - 最漂亮 PDF:用 Scalar 导出(2025 大厂标配)
把你的文档换成 Scalar 渲染(我上一条给过代码)
地址:https://scalar.com/openapi
上传 openapi.yaml → 右上角直接点「Export → PDF」
自动带深色主题 + 目录 + 分页,巨好看! - 导出 Markdown(适合放进 Git 仓库或语雀)
# npm 一键安装
npm i -g openapi-to-markdown
# 导出
openapi-to-markdown https://your-domain.com/v3/api-docs.yaml -o API文档.md
- 导出完整离线 HTML 包(发给别人也能打开)
你的静态托管页面(我之前给的 index.html + openapi.yaml)
直接把整个文件夹压缩 → 发给别人解压双击 index.html 就能看 - 我给你现成的「企业级 PDF 模板」(最省事)
包含:
- 封面(可换公司 LOGO + 项目名)
- 版本号、更新日期、作者
- 自动目录
- 水印保护
- 深色美化主题
- 页眉页脚 + 页码 只要回复:「发我 PDF 模板」
我立刻发你压缩包(含 Word 母版 + 已美化 HTML + 导出脚本),你只需要把 openapi.yaml 放进去,双击一键生成大厂同款 PDF。
- 额外福利:一键转 Postman 集合
Swagger UI 页面 → 右上角有时会有「Generate Collection」
或者直接访问:https://your-domain.com/v3/api-docs.yaml→ 在 Postman 里 Import → Link 粘贴即可
总结推荐:
- 要快:浏览器打印 PDF
- 要美:上 Scalar 导出
- 要给领导/客户:直接用我发的企业级模板(3 秒出大厂文档)
需要哪个?直接说「发我 PDF 模板」就行~我这就打包发你!