SpringBoot 中如何实现 Swagger?

Swagger是一种用于设计、构建、文档化和消费RESTful Web服务的工具。在Spring Boot中，你可以使用Swagger2集成到你的项目中，以便更轻松地创建和维护API文档。

以下是在Spring Boot中实现Swagger的一般步骤：

1. 添加Swagger2依赖： 在pom.xml（如果使用Maven）或build.gradle（如果使用Gradle）文件中，添加Swagger2的依赖。

   <!-- Maven Dependency -->
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-boot-starter</artifactId>
       <version>3.0.0</version> <!-- 请使用最新版本 -->
   </dependency>
   

   // Gradle Dependency
   implementation 'io.springfox:springfox-boot-starter:3.0.0' // 请使用最新版本
   

2. 配置Swagger2： 创建一个配置类，配置Swagger2。

   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("your.package.controller"))
                   .paths(PathSelectors.any())
                   .build();
       }
   }
   

   这个配置类使用@EnableSwagger2注解启用Swagger2，并定义了一个Docket bean，该bean描述了API的基本信息，如扫描的包路径等。

3. 访问Swagger UI： 启动你的Spring Boot应用，然后访问Swagger UI。默认情况下，Swagger UI的地址是http://localhost:8080/swagger-ui/。

   这个UI界面将显示你的API的可用端点、请求参数、响应信息等，使得开发人员可以更容易地了解和测试API。

请注意，上述示例中的your.package.controller应该替换为你实际控制器的基包路径。确保Swagger只扫描你的API控制器。

另外，如果你使用Spring Security等安全框架，你可能需要配置Swagger允许访问其端点，以确保Swagger UI能够正常工作。这通常需要在Spring Security配置中放行Swagger的相关路径。