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

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

公司一些老项目里加入了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)

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

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/100279.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号