Debian與Swagger集成步驟

在Debian系統上集成Swagger，通常是通過Spring Boot項目來實現的。以下是使用Springdoc-OpenAPI（適用于Spring Boot 3.x）進行集成的步驟：

1. 添加Maven依賴

在你的Spring Boot項目的pom.xml文件中，添加springdoc-openapi-starter-webmvc-ui依賴。例如：

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

2. 創建Swagger配置類

創建一個配置類來啟用Swagger文檔生成。例如：

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
            .info(new Info()
                .title("Your API Title")
                .description("Your API Description")
                .version("1.0.0")
                .license(new Info.License()
                    .name("Your API License")
                    .url("https://your-api-license-url")));
    }
}

3. 添加Controller并添加相應注解

在你的Controller類中使用Swagger注解來描述API操作。例如：

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import org.springframework.web.bind.annotation.*;

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

    @GetMapping("/data")
    @Operation(summary = "Get data", description = "Get data from the system")
    public Data getData(
        @Parameter(description = "Query parameter", required = false, schema = @Schema(type = "string")) String query) {
        // Your implementation here
        return new Data();
    }

    @PostMapping("/data")
    @Operation(summary = "Post data", description = "Post data to the system")
    public Data postData(@RequestBody Data data) {
        // Your implementation here
        return data;
    }
}

4. 運行項目

啟動你的Spring Boot應用程序。默認情況下，Swagger UI可以通過訪問http://localhost:8080/swagger-ui/index.html來訪問。

5. 訪問Swagger文檔

打開瀏覽器，訪問上述URL，你應該能夠看到Swagger UI界面，其中包含了你的API文檔和測試接口。

請注意，以上步驟是基于Spring Boot 3.x和Springdoc-OpenAPI的集成。如果你使用的是Spring Boot 2.x和Springfox，步驟會有所不同，需要添加springfox-swagger2和springfox-swagger-ui依賴，并配置相應的Springfox配置類。