Spring Boot 整合 Swagger 教程详解

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
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.any()) // 对所有API进行扫描
                .paths(PathSelectors.any()) // 对所有路径进行扫描
                .build()
                .apiInfo(apiInfo());
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("示例Spring Boot项目API文档")
                .description("这是一个使用Swagger2构建的API文档")
                .version("1.0")
                .build();
    }
}

这段代码定义了一个配置类SwaggerConfig，使用@EnableSwagger2注解启用Swagger 2.0。在api()方法中，我们配置了Docket Bean，指定了文档类型为SWAGGER\_2，并设置了要扫描的API和路径，以及API的基本信息。这样就可以通过指定的URL路径访问Swagger的API文档页面，从而方便地测试和管理你的API。