Spring Boot 3项目集成Swagger3教程

Spring Boot 3 (目前最新版本是2.x) 项目集成 Swagger 3 (通常指 OpenAPI 3.0 或者以前的 Swagger UI 3.x) 的步骤如下：

1. 添加依赖：首先，在你的 `pom.xml` 文件中添加 Swagger 和相关的依赖，例如，使用 Maven 或 Gradle：

   <!-- Maven -->
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-boot-starter</artifactId>
       <version>3.0.0-M5</version>  // 使用最新的Swagger 3.x版本
   </dependency>

   <!-- Gradle -->
   implementation 'io.springfox:springfox-boot-starter:3.0.0-M5'

2. 配置Swagger：在配置文件（application.properties 或 application.yml）中设置Swagger的基本信息，如标题、描述等：

   springfox.documentation.title=myApi
   springfox.documentation.description=A sample API description
   springfox.documentation.version=1.0.0

3. 注解支持：使用 `@ApiOperation`, `@GetMapping`, `@PostMapping` 等 Swagger注解来标记API的元数据。

4. 创建文档：创建一个资源类并使用注解来生成API文档。例如：

   @RestController
   @RequestMapping("/api")
   public class MyController {
   
       @GetMapping("/users")
       @ApiOperation(value = "Get Users", notes = "Returns a list of users.")
       List<User> getUsers() {
           return userService.getUsers();
       }
   }

5. 启动Swagger：如果你希望在浏览器中访问Swagger界面，可以启用WebMvcEndpointConditional扫描器：

   @EnableSwagger2WebMvc
   @SpringBootApplication
   public class Application implements WebMvcConfigurer {
       // ...其他配置
   }

6. 访问文档：启动应用后，通过 `/swagger-ui.html` （如果使用默认路径）或在Swagger配置中指定的URL访问Swagger页面，查看API文档。