【Swagger2】【1】匹配多个controller

最新推荐文章于 2024-05-04 04:45:41 发布

转载最新推荐文章于 2024-05-04 04:45:41 发布 · 413 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/huashengweilong/p/10806835.html

文章标签：

#测试

本文介绍了在拥有多个模块的项目中，如何使用Swagger2来为所有控制器生成统一的API文档。通过两种方法实现：一是使用公共父类，二是通过接口注解选择控制器。文章对比了正确与错误的配置方式，帮助开发者避免常见陷阱。

前言：项目中有多个模块，所以有多个controller层。我是用方案二的

正文：

方案一：使用多个controller的共同拥有的父类

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.xx"))
            .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.xx.*.controller"))
            .paths(PathSelectors.any())
            .build();
}

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

参考博客：

swagger2 如何匹配多个controller - 贾树丙 - 博客园
http://www.cnblogs.com/acm-bingzi/p/swagger2-controller.html

转载于:https://www.cnblogs.com/huashengweilong/p/10806835.html