### 生成或导出
Swagger接口文档的方法
生成或导出
Swagger接口文档可以通过多种方式实现，具体步骤如下：
#### 1. 使用 `
swagger2markup` 工具
为了将
Swagger接口文档转换为离线文档（如PDF、HTML、Markdown等），可以使用 `
swagger2markup` 工具。首先需要在项目中引入相关依赖[^2]：
```xml
<dependency>
<groupId>io.github.
swagger2markup</groupId>
<artifactId>
swagger2markup</artifactId>
<version>1.3.1</version>
</dependency>
```
引入依赖后，可以通过以下代码生成静态文档[^1]：
```java
import io.github.
swagger2markup.
Swagger2MarkupConverter;
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Paths;
public class
SwaggerExporter {
public static void main(String[] args) throws IOException {
// 指定
Swagger接口的URL
URL url = new URL("http://localhost:8080/v2/api-docs");
// 使用
Swagger2MarkupConverter进行转换
Swagger2MarkupConverter.from(url)
.build()
.toFolder(Paths.get("src/docs/asciidoc/generated")); // 指定输出目录
System.out.println("
Swagger接口文档已成功导出到指定目录！");
}
}
```
上述代码会从指定的
Swagger接口URL读取数据，并将其转换为AsciiDoc格式的文档[^1]。
#### 2. 获取 `
swagger.json` 文件
如果不想通过编程方式生成文档，可以直接获取 `
swagger.json` 文件[^3]：
- **方式一**：访问 `http://localhost:8080/v2/api-docs`，下载返回的JSON内容。
- **方式二**：通过浏览器开发者工具（F12）查看网络请求，找到 `
swagger.json` 的响应内容并保存。
#### 3. 转换 `
swagger.json` 为其他格式
获取到 `
swagger.json` 文件后，可以通过在线工具将其转换为其他格式的文档：
- **转DOC**：使用在线工具如 [在线工具](https://example.com) 将JSON转换为Word文档。
- **转PDF/Markdown**：使用工具如 [DOCWAY](https://example.com) 将JSON转换为PDF或Markdown格式。
####
注意事项
- 如果项目中有多个
Swagger分组，可能需要分别访问对应的 `/v2/api-docs`
接口以获取完整的JSON文件[^3]。
- 确保
Swagger接口正常运行且能够被访问，否则可能会遇到404错误[^3]。
### 示例代码
以下是一个完整的示例代码，用于从
Swagger接口生成AsciiDoc格式的文档：
```java
import io.github.
swagger2markup.
Swagger2MarkupConverter;
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Paths;
public class
SwaggerExporterExample {
public static void main(String[] args) throws IOException {
URL
swaggerUrl = new URL("http://localhost:8080/v2/api-docs");
Swagger2MarkupConverter.from(
swaggerUrl)
.build()
.toFolder(Paths.get("src/docs/asciidoc/generated"));
System.out.println("文档生成完成！");
}
}
```
博客指出在信息技术中，字段值和类名不能相同，若相同会导致显示不出来的问题，强调了编程时需注意二者命名的区分。
扫一扫
1278
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
