解决spring boot中使用拦截器导致swagger文档无法访问

目录

问题场景

解决方案


问题场景

我们的spring boot项目通常会使用接口文档管理依赖如knife4j(swagger3)

Spring Boot3整合knife4j(swagger3)_springboot3 knife4j-CSDN博客

通常也会使用拦截器来做登录鉴权、接口限流等操作,但是使用拦截器会导致swagger接口文档的访问被拦截,导致无法正常访问。

解决方案

这个问题解决起来非常简单,只需要配置一下拦截器放行路径,把swagger相关的所有资源访问都放行即可。

在项目的WebMVC配置类里面的拦截器追加排除路径:

java 复制代码
//拦截器公共排除路径设置
    private InterceptorRegistration configureInterceptorPublicExcludePathPatterns(InterceptorRegistry registry, HandlerInterceptor interceptor) {
        return registry.addInterceptor(interceptor)
                // 排除特定业务接口
                .excludePathPatterns("/captcha/**", "/test/**", "/", "/user/login/**","/function-system/**")
                //排除静态资源
                .excludePathPatterns("*.html", "/images/**")
                //排除swagger相关
                .excludePathPatterns("/doc.html","/webjars/**", "/swagger-resources", "/swagger-resources/**", "/v3/**", "/favicon.ico", "Mozilla/**");

    }

关键代码

java 复制代码
 //排除swagger相关
.excludePathPatterns("/doc.html","/webjars/**", "/swagger-resources", "/swagger-resources/**", "/v3/**", "/favicon.ico", "Mozilla/**");

放行后swagger文档就能正常访问了。

相关推荐
穿林鸟1 小时前
Spring Boot项目信创国产化适配指南
java·spring boot·后端
伏游1 小时前
【BUG】生产环境死锁问题定位排查解决全过程
服务器·数据库·spring boot·后端·postgresql·bug
此木|西贝1 小时前
【设计模式】模板方法模式
java·设计模式·模板方法模式
wapicn991 小时前
手机归属地查询Api接口,数据准确可靠
java·python·智能手机·php
hycccccch2 小时前
Springcache+xxljob实现定时刷新缓存
java·后端·spring·缓存
爱的叹息2 小时前
SpringBoot集成Redis 灵活使用 TypedTuple 和 DefaultTypedTuple 实现 Redis ZSet 的复杂操作
spring boot·redis·bootstrap
wisdom_zhe2 小时前
Spring Boot 日志 配置 SLF4J 和 Logback
java·spring boot·logback
揣晓丹2 小时前
JAVA实战开源项目:校园失物招领系统(Vue+SpringBoot) 附源码
java·开发语言·vue.js·spring boot·开源
于过2 小时前
Spring注解编程模型
java·后端
北随琛烬入2 小时前
Spark(10)配置Hadoop集群-集群配置
java·hadoop·spark