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配置类。