SpringBootWeb 篇-入门了解 Swagger 的具体使用

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
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.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
}

这段代码定义了一个配置类SwaggerConfig，使用@EnableSwagger2注解启用Swagger 2.0。在api()方法中，我们创建了一个Docket的Bean，指定了使用DocumentationType.SWAGGER_2进行API文档的创建，并通过apis()方法指定了只包含带有Api和ApiOperation注解的处理器。这表示Swagger将只为有这些注解的类和方法生成API文档。最后，通过paths(PathSelectors.any())方法包含所有路径。这个配置类应该被Spring Boot应用的@Configuration注解的类扫描并加载。