解决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文档就能正常访问了。

相关推荐
starzy19904 小时前
Hadoop介绍总结:一张图理清组件、生态与版本
java·hadoop
yyuuuzz4 小时前
nginx 502 排查,先看上游超时那一行
android·java·运维·nginx·502
Java后端的Ai之路4 小时前
Java并发编程25-集合的线程安全
java·安全·面试
雪芽蓝域zzs4 小时前
第 3 章:完成 User 完整 CRUD(新增、根据 id 查询、修改、删除、查询全部)
spring boot
CoderYanger5 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第一弹)
java·数据库·spring·面试·java-ee·tomcat·mybatis
码云社区5 小时前
Java租房平台源码方案:Vue 3房源审核、UniApp预约看房与房东管理
java·vue.js
codigger6 小时前
ThreadLocal 会内存泄露吗?
java·内存泄漏·threadlocal
挖掘狂人7 小时前
ThreadLocal 会内存泄露吗?
java·安全·架构
她的男孩7 小时前
审批人选了「部门主管」,发起却报 Unknown property:Forge Admin 启动时补齐组织变量
spring boot·低代码·工作流引擎
未秃头的程序猿7 小时前
给新模块加了个 @MapperScan,启动崩了,最后发现跟 MapperScan 没关系
java·后端·mybatis