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

本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net

目录

问题场景

解决方案

问题场景

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

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

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

解决方案

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

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

//拦截器公共排除路径设置
    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/**");
 
    }

关键代码

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

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