swagger支持多controller配置

女爷i 2022-02-01 12:53 291阅读 0赞

一般配置

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;
    
    /**
     * @author gsls200808
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2 {
        
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.vvvtimes.person.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("WIS RESTful APIs")
                    .description("RESTful APIs说明")
                    .termsOfServiceUrl("http://localhost:8989/swagger-ui.html/")
                    .version("1.0")
                    .build();
        }
    }

当要使用多个controller时可以用Predicates.or方法

@Bean
        public Docket createRestApi() {
            com.google.common.base.Predicate<RequestHandler> selector1 = RequestHandlerSelectors.basePackage("com.vvvtimes.person.controller");
            com.google.common.base.Predicate<RequestHandler> selector2 = RequestHandlerSelectors.basePackage("com.vvvtimes.person.weChatController");
            com.google.common.base.Predicate<RequestHandler> selector3 = RequestHandlerSelectors.basePackage("com.vvvtimes.person.appController");
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(Predicates.or(selector1,selector2,selector3))
                    //.apis(RequestHandlerSelectors.basePackage("com.vvvtimes.person.controller"))
                    .paths(PathSelectors.any())
                    .build();
        }

其中Predicates需要 import com.google.common.base.Predicates;