Springboot3.X版本如何自动生成 API 文档

Spring Boot 3.2.4 可以使用多种工具来自动生成 API 文档。根据上述搜索结果，以下是几种流行的工具和方法：

### 1. Springdoc OpenAPI

Springdoc OpenAPI 是一个为 Spring 应用程序自动生成 OpenAPI 3 规范的库。它支持 Spring MVC、Spring WebFlux 和 Spring Data REST repositories。要使用 Springdoc OpenAPI，你需要添加相应的依赖到你的项目中。

#### 添加依赖
对于 Spring Boot 3.x 应用程序，你可以在 `pom.xml` 中添加以下依赖：

```xml
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.1.0</version>
</dependency>
```

或者，如果你使用的是 Gradle，可以在 `build.gradle` 中添加：

```gradle
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
```

#### 配置和使用
一旦添加了依赖，你可以通过访问 `http://localhost:8080/swagger-ui/index.html` 来查看和测试你的 API 文档。你还可以使用注解（如 `@Operation`、`@ApiResponse` 等）来自定义你的 API 文档。

### 2. Springfox

Springfox 是另一个流行的库，用于为 Spring Boot 应用程序生成 Swagger 2 规范的 API 文档。虽然它最初是为 Swagger 2 设计的，但也可以与 OpenAPI 3 一起使用。

#### 添加依赖
对于 Springfox，你可以在 `pom.xml` 中添加以下依赖：

```xml
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
```

#### 配置和使用
添加依赖后，你可以通过访问 `http://localhost:8080/swagger-ui.html` 来查看和测试你的 API 文档。你可以通过创建配置类并使用注解（如 `@EnableSwagger2`）来自定义你的 API 文档。

### 3. 其他工具

除了 Springdoc OpenAPI 和 Springfox，还有其他一些工具可以用来生成 API 文档，例如：

- **Swagger Codegen**: 可以根据 OpenAPI 规范自动生成客户端库、服务器存根和 API 文档。
- **ReDoc**: 是一个开源的 Markdown 文档工具，可以与 OpenAPI 规范一起使用，生成漂亮的文档界面。

### 总结

Spring Boot 3.2.4 支持多种工具来自动生成 API 文档。Springdoc OpenAPI 是为 OpenAPI 3 设计的，而 Springfox 则支持 Swagger 2。你可以根据项目需求和个人偏好选择最适合你的工具。在使用这些工具时，确保选择与你的 Spring Boot 版本兼容的依赖版本，并遵循相应的配置和使用指南来生成和查看你的 API 文档。