swagger根据注解屏蔽大量不需要的接口

6 篇文章 0 订阅
1 篇文章 0 订阅

公司一些老项目里加入了swagger,由于项目太大,接口巨多,扫描的无用的接口信息很恶心,用包路径区分的方式解决不了旧的controller上也新加了文档注解但扫描不到的问题。

偶然发现扫描api路径的时候可以选择只扫描带注解的,这个很实用,具体例子如下:

return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))          //只扫描有api注解的类
                //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//只扫描有ApiOperation注解的方法
                .paths(PathSelectors.any())
                .build()
                .enable(!ENV.PRD.equals(ENV.getEnv(env)))
                .apiInfo(apiInfo());

核心是两个:RequestHandlerSelectors.withClassAnnotation(Api.class)   

                      RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)

看自己项目需要选择其中一个过滤方式就行了。

  • 1
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值