Linux Swagger如何與Spring Boot結合使用

在Linux系統上將Swagger與Spring Boot結合使用，可以幫助你創建、測試和文檔化你的RESTful API。以下是集成Swagger與Spring Boot的步驟：

1. 添加依賴

在你的Spring Boot項目的pom.xml文件中添加Swagger和Springfox的依賴。例如，使用Maven時，添加以下依賴：

<dependencies>
    <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>

如果你使用的是Gradle，則在build.gradle文件中添加以下依賴：

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
}

2. 配置Swagger

創建一個名為SwaggerConfig.java的Java配置類，并添加如下代碼：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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.basePackage("com.example.demo.controller")) // 請替換為您的控制器包名
                .paths(PathSelectors.any())
                .build();
    }
}

請確保將com.example.demo.controller替換為你實際的控制器包名。

3. 啟動Spring Boot應用

使用以下命令啟動你的Spring Boot應用：

• 如果你使用Maven：

  ./mvnw spring-boot:run
  

• 如果你使用Gradle：

  ./gradlew bootRun
  

4. 訪問Swagger UI

一旦你的應用啟動，你可以通過瀏覽器訪問Swagger UI。默認情況下，Swagger UI的地址是：

http://localhost:8080/swagger-ui.html

在這里，你可以查看和測試你的API。

5. 配置Swagger UI（可選）

你可以進一步自定義Swagger UI，例如添加認證、自定義樣式等。以下是一個簡單的示例，展示如何添加基本認證：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.Collections;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 設置文檔標題
                .title("Your API Title")
                // 設置聯系人信息
                .contact(new Contact("Your Name", "www.example.com", "your.email@example.com"))
                // 設置更多信息...
                .version("Version Number")
                .build();
    }
}

通過以上步驟，你應該能夠在Linux環境中成功集成Swagger與Spring Boot，并使用Swagger UI來測試和文檔化你的API。