springboot swagger 配置

Spring Boot Swagger是一个用于集成Swagger UI的工具，它允许开发者轻松地生成API文档并进行测试。在Spring Boot项目中配置Swagger，通常需要以下几个步骤：

1. 添加依赖：首先，在`pom.xml`或`build.gradle`文件中添加Swagger的starter依赖，如Springfox或Springdoc OpenAPI。

   <!-- Maven -->
   <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-boot-starter</artifactId>
   </dependency>

   <!-- Gradle (Springfox) -->
   implementation 'io.springfox:springfox-boot-starter'

或者使用Springdoc:

   implementation 'org.springdoc:springdoc-openapi-ui'
   implementation 'org.springdoc:springdoc-openapi-autoconfigure'

2. 配置启用：在Spring Boot主类上添加`@EnableSwagger2`或`@EnableOpenAPI`注解，启用Swagger功能。

   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import springfox.documentation.builders.PathSelectors;
   import springfox.documentation.builders.RequestHandlerSelectors;
   import springfox.documentation.spi.DocumentationType;
   import springfox.documentation.spring.web.plugins.Docket;

   @SpringBootApplication
   @EnableSwagger2
   public class Application {
       public static void main(String[] args) {
           SpringApplication.run(Application.class, args);
       }

       // 使用Docket创建一个配置，选择哪些路径和控制器暴露给Swagger
       @Bean
       public Docket api() {
           return new Docket(DocumentationType.SWAGGER_2)
                   .select()
                   .apis(RequestHandlerSelectors.any())
                   .paths(PathSelectors.any())
                   .build();
       }
   }

3. 配置UI访问：默认情况下，Swagger UI会通过`/{yourBasePath}/swagger-ui.html`路由访问。如果需要自定义URL，可以设置`@EnableSwagger2WebMvc`和`@SwaggerUiConfig`。

4. 提供资源元数据：你可以提供一些元数据，例如标题、描述、版本等，通过`@ApiOperation`, `@ApiModel`, `@ApiModelProperty`等注解。

import org.springframework.web.bind.annotation.GetMapping;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@Api(value = "Hello API", description = "This is a simple Hello World API")
@GetMapping("/hello")
public String hello() {
    return "Hello, World!";
}