【springboot系列】springboot3集成springdoc

Spring Boot 3 整合 SpringDoc 的方式和以前版本的整合方式类似，但是需要注意的是，SpringDoc 支持的 Spring Boot 版本可能不包括3。如果你想要在 Spring Boot 3 项目中使用 SpringDoc，你可能需要等待 SpringDoc 对应的支持版本发布。

以下是一个基本的整合示例：

1. 在 pom.xml 中添加依赖：

<dependencies>
    <!-- Spring Boot 依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- SpringDoc 依赖 -->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.6.11</version> <!-- 请使用最新的兼容版本 -->
    </dependency>
</dependencies>

2. 在 application.properties 或 application.yml 中配置 SpringDoc：

# application.properties
springdoc.api-docs.path=/api-docs
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.operationsSorter=method
springdoc.swagger-ui.tagsSorter=alpha

3. 在 Spring Boot 启动类上添加 @EnableOpenApi 注解：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springdoc.core.annotations.EnableOpenApi;
 
@SpringBootApplication
@EnableOpenApi
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

4. 创建一个简单的 REST 控制器：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, SpringDoc!";
    }
}

启动 Spring Boot 应用后，访问 http://localhost:8080/swagger-ui.html 即可看到 Swagger 文档界面。

注意：SpringDoc 可能不支持 Spring Boot 3，如果你尝试集成时遇到问题，请检查 SpringDoc 的官方文档或社区是否有关于 Spring Boot 3 的支持。如果没有，你可能需要等待官方发布兼容的版本，或者考虑使用其他 API 文档生成工具。