Linux環境下Swagger與Spring Boot如何結合

在Linux環境下，將Swagger與Spring Boot結合使用可以讓你更方便地構建和測試RESTful API。以下是詳細的步驟指南：

1. 添加依賴

首先，在你的Spring Boot項目的pom.xml文件中添加Swagger和Swagger UI的依賴。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Swagger2 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Swagger UI -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

2. 配置Swagger

創建一個配置類來配置Swagger。

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();
    }
}

3. 啟動應用

確保你的Spring Boot應用已經啟動。你可以使用以下命令來啟動應用：

./mvnw spring-boot:run

4. 訪問Swagger UI

在瀏覽器中訪問以下URL來查看Swagger UI界面：

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

5. 配置API文檔

在你的控制器類和方法上添加Swagger注解，以便生成更詳細的API文檔。

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
@Api(tags = "示例控制器")
public class ExampleController {

    @GetMapping("/hello")
    @ApiOperation("返回一個簡單的問候信息")
    public String sayHello() {
        return "Hello, World!";
    }
}

6. 更新Swagger文檔

每次修改控制器或方法時，Swagger會自動更新API文檔。你可以隨時訪問http://localhost:8080/swagger-ui.html來查看最新的API文檔。

總結

通過以上步驟，你可以在Linux環境下成功地將Swagger與Spring Boot結合使用，從而更方便地構建和測試RESTful API。Swagger不僅提供了直觀的API文檔界面，還支持實時更新和交互式測試功能。