如何配置一个swagger拦截器

Question

如何配置一个Swagger2.x的拦截器，解决页面弹窗报错的问题

Answer 1

引自免费微信小程序：皆我百晓生

要配置一个 Swagger 2.x 的拦截器来解决页面弹窗报错的问题，你需要遵循以下几个步骤：

1. 创建一个实现 HandlerInterceptor 接口的类，并覆盖其方法。
2. 在这个类中，处理请求和响应，以便在发送请求前和接收响应后执行一些操作。
3. 配置 Spring Boot 项目，使其使用你创建的拦截器。

下面是一个详细的示例：

首先，创建一个名为 SwaggerInterceptor 的类，它实现了 HandlerInterceptor 接口：

import org.springframework.http.ResponseEntity;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class SwaggerInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求之前执行的操作
        return true; // 返回true表示继续执行后续流程，返回false则停止
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在请求之后但视图渲染之前执行的操作
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求完成（包括视图渲染）之后执行的操作
        if (response instanceof ResponseEntity && ((ResponseEntity<?>) response).getStatusCode().is5xxServerError()) {
            // 检查是否有500错误，如果有，则修改状态码为200，避免弹窗
            ((ResponseEntity<?>) response).setStatusCode(HttpStatus.OK);
        }
    }
}

接下来，在 Spring Boot 应用的配置文件中启用这个拦截器：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SwaggerInterceptor());
    }
}

这样就配置好了 Swagger 2.x 的拦截器。当遇到 500 状态码时，它会将状态码更改为 200，从而避免页面弹窗报错。

注意：这个解决方案可能会影响应用程序的其他部分，因为任何导致 500 错误的情况都将被隐藏并显示为成功。在生产环境中，建议只对 Swagger UI 进行这样的处理，而不是全局应用。为了达到这个目标，你可以在 preHandle 方法中检查请求路径是否与 Swagger 相关，如果是，则添加拦截逻辑。例如，可以检查请求 URL 是否包含 /v2/api-docs 或类似的路径。这里就不提供具体的代码，因为这取决于你的具体需求和项目结构。