Linux系統中Swagger與Spring Boot如何結合

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

1. 創建Spring Boot項目

首先，你需要創建一個Spring Boot項目。你可以使用Spring Initializr（https://start.spring.io/）來快速生成項目結構。

• 選擇項目類型：Maven Project 或 Gradle Project
• 選擇語言：Java
• 選擇Spring Boot版本
• 添加依賴：Spring Web, Springfox Swagger2

2. 配置Swagger

在你的Spring Boot項目中，添加Swagger依賴并配置Swagger。

Maven依賴

如果你使用的是Maven，在pom.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>

Gradle依賴

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

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

3. 配置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();
    }
}

4. 啟動Spring Boot應用

在你的主應用類上添加@SpringBootApplication注解，并啟動應用。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

5. 訪問Swagger UI

啟動你的Spring Boot應用后，打開瀏覽器并訪問以下URL：

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

你應該能夠看到Swagger UI界面，其中列出了你的API文檔。

6. 編寫控制器

編寫一些控制器來測試Swagger。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class ExampleController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

7. 更新Swagger文檔

每次你更新控制器或添加新的API時，Swagger會自動更新文檔。你可以刷新瀏覽器頁面來查看最新的API文檔。

通過以上步驟，你就可以在Linux系統中成功地將Swagger與Spring Boot結合使用了。這樣可以幫助你更方便地構建和測試RESTful API。