springboot项目配置swagger2

Spring Boot 配置 Swagger 2是一个常见的实践，用于生成RESTful API文档。以下是步骤：

1. 添加依赖：首先，在项目的`pom.xml`文件中添加Swagger和 springfox-boot-starter-swagger2的依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter-swagger2</artifactId>
    <version>3.x.x</version> <!-- 请替换为最新版本 -->
</dependency>

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

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

3. 配置扫描路径：如果需要特定包下的API自动发现，可以设置`@ApiScan`注解，例如：

@ApiScan("com.example.demo.controller")

4. 定义资源文档：创建`Docket`对象并配置它，如设置标题、描述等，还可以选择哪些控制器类暴露给Swagger：

@Configuration
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API Title")
                .description("A brief description of your API")
                .contact(new Contact("Your Name", "your-email@example.com", "http://www.example.com"))
                .version("1.0.0")
                .build();
    }
}

5. 访问文档：启动应用后，通常在`localhost:8080/swagger-ui.html`或自定义端口加上`/v2/api-docs`可以查看到生成的API文档。