欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Swagger:swagger扫描不同模块的controller

程序员文章站 2022-07-02 14:49:49
...

一、错误方法,使用  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();
    }

 

Swagger:swagger扫描不同模块的controller 

相关标签: Swagger swagger2