如何在Spring Boot中集成Swagger

在Spring Boot項目中集成Swagger是一個相對簡單的過程。Swagger可以自動生成API文檔，并提供一個交互式的界面來測試這些API。以下是在Spring Boot中集成Swagger的步驟：

1. 添加依賴

首先，在你的pom.xml文件中添加Swagger和Springfox的依賴。Springfox是一個專門用于Spring Boot的Swagger集成庫。

<dependencies>
    <!-- 其他依賴 -->

    <!-- Swagger依賴 -->
    <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>
</dependencies>

2. 配置Swagger

創建一個新的Java類，例如SwaggerConfig，并使用@Configuration注解標記它。在這個類中，你將配置Swagger以掃描你的API并生成文檔。

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

在這個配置中，Docket對象定義了Swagger API的描述。@EnableSwagger2注解啟用了Swagger支持。

3. 訪問Swagger UI

啟動你的Spring Boot應用程序后，你可以通過訪問http://localhost:8080/swagger-ui.html（假設你的應用程序運行在端口8080上）來查看Swagger UI。這將顯示一個交互式的API文檔，你可以在這里測試你的API。

4. 自定義Swagger配置（可選）

你可以通過Docket對象來自定義Swagger的各個方面，例如設置API的版本、描述、標題等。你還可以定義全局的API配置，如全局的響應消息模板等。

5. 處理API版本控制（可選）

如果你需要處理API版本控制，你可以使用@ApiVersion注解在你的控制器類或方法上。然后，你可以在Swagger配置中使用@Version注解來指定哪個版本的API應該被包括在文檔中。

通過以上步驟，你應該能夠在Spring Boot項目中成功集成Swagger，并自動生成API文檔。