【swagger2】swagger2配置多个controller

最新推荐文章于 2023-04-21 16:57:16 发布

ooooooooooooooxiaosu

最新推荐文章于 2023-04-21 16:57:16 发布

阅读量1.5k

点赞数

分类专栏： SpringBoot 文章标签： java 开发语言 swagger2

原文链接：https://www.likecs.com/show-525690.html

版权

SpringBoot 专栏收录该内容

44 篇文章 0 订阅

订阅专栏

本文介绍了如何在Swagger2中优雅地处理多个Controller的文档整合。方法一是通过设置父类，让所有Controller继承同一父类；方法二是利用@RestController注解，将所有实现该接口的Controller纳入文档。然而，直接使用通配符或指定多个包路径会导致错误。通过这两种方式，可以更好地管理和展示API文档。

摘要由CSDN通过智能技术生成

解决方法

方法一：使用多个controller的共同拥有的父类，即精确到两个controller的上一级

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.shubing"))
            .paths(PathSelectors.any())
            .build();
}

方法二：指定所有controller的都实现的一个接口，比如@RestController

@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.shubing.*.controller"))
            .paths(PathSelectors.any())
            .build();
}

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.shubing.course.controller"))
            .apis(RequestHandlerSelectors.basePackage("com.shubing.user.controller"))
            .paths(PathSelectors.any())
            .build();
}