swagger2 如何匹配多个controller

最新推荐文章于 2023-02-22 09:17:14 发布

原创最新推荐文章于 2023-02-22 09:17:14 发布 · 792 阅读

CC 4.0 BY-SA版权

这篇博客介绍了如何使用Swagger来配置Spring Boot应用，展示如何为单个和多个控制器生成API文档。通过`@Bean`注解的`Docket`创建，使用`RequestHandlerSelectors`选择控制器包路径，并结合`paths(PathSelectors.any())`来构建API文档。正确配置能确保Swagger正确捕获指定控制器的所有API。

正确：

指定单个：

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里一定要标注你控制器的位置
.apis(RequestHandlerSelectors.basePackage("com.bala.system.controller"))
                .paths(PathSelectors.any())
                .build();
    }

多个：

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里一定要标注你控制器的位置
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build();
    }

错误：

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里一定要标注你控制器的位置
                .apis(RequestHandlerSelectors.basePackage("com.bala.system.controller"))
                .apis(RequestHandlerSelectors.basePackage("com.bala.user.controller"))
                .paths(PathSelectors.any())
                .build();
    }