Swagger如何匹配多個Controller類或者目錄

提示：方法四或許是你們需要的方法！！！

 

方法一（最普通的方式）：匹配一個controller目錄下的所有controller類。

　　

 @Bean
    public Docket creatRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //關鍵語句
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")
                )
                .paths(PathSelectors.any())
                .build();
    }

 

方法二：匹配有指定注解的類。

 @Bean
    public Docket creatRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //關鍵語句
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)
                )
                .paths(PathSelectors.any())
                .build();
    }

 

方法三：匹配有指定注解的方法。

@Bean
    public Docket creatRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //關鍵語句
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)
                )
                .paths(PathSelectors.any())
                .build();
    }

 

方法四：我覺得是最重要的方法（強烈推薦！！！！）：可以匹配多個controller包（多個controller包不在同一級）

             

 @Bean
    public Docket creatRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(Predicates.or(RequestHandlerSelectors.basePackage("com.example.demo.controller"),
                        RequestHandlerSelectors.basePackage("com.example.demo.gp.controller"),
                        RequestHandlerSelectors.basePackage("com.gp.callback.controller"))
                )
                .paths(PathSelectors.any())
                .build();
        
    }

 如果上面的Predicates類報紅的話，pom文件導入jar包

 <!-- guava -->
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>23.0</version>
        </dependency>

 

總結：相比四種方法，如果項目中只有一個controller包的話，直接使用方法一就可以了，如果項目中有多個controller包，那么我建議使用方法四。