工具概述

Swagger 模块合并导出工具是一款用于将多个 Swagger API Spec 定义文档合并并导出为单个 PDF 的在线工具。导出的 PDF 带有全局索引目录，提供了对于简体和繁体中文的支持。

工具提供了对导出文档的文件名、文档标题、描述和版本号自定义的支持，此外，还支持传入 Map 自定义文件名和其 Tag 前缀的映射，之后输出目录将会包含带有此前缀的 Tag，并且按照其优先级排序。

此工具不会将您的文档上传到后台服务器，所有处理都在浏览器本地进行。

可导出为单个 Swagger API Spec .json 文件，或者直接将其转换为 .pdf 文档：

在线体验

需要完整加载字库，加载速度可能稍慢：

官方网站

开发动机

Github 上存在种类繁多的通过 Swagger 注解生成 Swagger API Spec，然后通过 SwaggerUI 查看的工具，此外也存在多个将 API Spec 转换为 HTML、DOCX、PDF 的工具，但这些更多针对的是单个 API Spec 文档。Swagger 新版本支持在一个 SwaggerUI 中查看多个 Spec API，但是社区缺少工具能够将多个 Spec API 合并为单个文件的能力 —— 生成的多个 PDF 文件要么不支持中文字符，要么含有独立的目录，使用体验不佳。

本工具扫描多个 API Spec 文档，然后为每个文档的 Class 定义、定义的引用进行全局符号替换，然后将所有 API 数据合并为单个 API Spec 文档，然后利用带有中文字库的 RapiPdf 将合并后的文档转换为带有全局书签目录的 PDF 文档。

此过程可以无缝的和 Maven 编译流程整合（通过 clojure-maven-plugin 插件在编译时执行 Clojure 代码），也可以在浏览器本地计算和生成（如本网站）。