Swagger：swagger扫描不同包的controller

原创已于 2022-03-16 13:10:40 修改 · 5.1k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

于 2020-10-31 10:34:55 首次发布

Swagger 专栏收录该内容

3 篇文章

订阅专栏

本文档对比了在配置Swagger时的两种不同方法。错误的方法是使用`io.renren.modules.*.controller`作为包扫描路径，这可能导致不精确的API文档生成。而正确的方式是定位到两个具体Controller类的上一级父包，如`io.renren.modules`，以确保只包含所需Controller的API信息。这种方法提高了Swagger文档的准确性和维护性。

一、错误方法，使用 io.renren.modules.*.controller

 public Docket createRestApi() {
        log.info("======================== 当前环境是否开启Swagger：" + SwaggerSwitch + " ========================");
        return new Docket(DocumentationType.SWAGGER_2)
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                //配置是否启用Swagger，如果是false，在浏览器将无法访问，默认是true
                .enable(SwaggerSwitch)
                //apiInfo： 添加api详情信息，参数为ApiInfo类型的参数，这个参数包含了第二部分的所有信息比如标题、描述、版本之类的，开发中一般都会自定义这些信息
                .apiInfo(apiInfo())
                .select()
                //apis： 添加过滤条件,
                //加了ApiOperation注解的类，才生成接口文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //包下的类，才生成接口文档
                .apis(RequestHandlerSelectors.basePackage("io.renren.modules.*.controller"))
                .paths(PathSelectors.any())
                .build();
    }

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

    public Docket createRestApi() {
        log.info("======================== 当前环境是否开启Swagger：" + SwaggerSwitch + " ========================");
        return new Docket(DocumentationType.SWAGGER_2)
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                //配置是否启用Swagger，如果是false，在浏览器将无法访问，默认是true
                .enable(SwaggerSwitch)
                //apiInfo： 添加api详情信息，参数为ApiInfo类型的参数，这个参数包含了第二部分的所有信息比如标题、描述、版本之类的，开发中一般都会自定义这些信息
                .apiInfo(apiInfo())
                .select()
                //apis： 添加过滤条件,
                //加了ApiOperation注解的类，才生成接口文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                //包下的类，才生成接口文档
                .apis(RequestHandlerSelectors.basePackage("io.renren.modules"))
                .paths(PathSelectors.any())
                .build();
    }