springdoc-openapi在Spring Boot 2.x项目中Swagger UI访问问题解析

在使用springdoc-openapi-ui库为Spring Boot 2.x项目集成API文档时，开发者可能会遇到无法访问Swagger UI页面的问题。本文将深入分析这一常见问题的原因，并提供多种解决方案。

问题现象

当开发者在Spring Boot 2.7.15项目中使用springdoc-openapi-ui 1.7.0或1.8.0版本时，能够成功访问/v3/api-docs端点获取JSON格式的API文档，但访问/swagger-ui.html时却出现"Whitelabel Error Page"错误页面。

根本原因分析

这个问题通常与Spring MVC的配置方式有关。springdoc-openapi-ui库依赖于Spring MVC的自动配置机制来注册Swagger UI相关的资源处理器和控制器。当项目中使用以下两种配置方式时，可能会导致自动配置失效：

1. 项目中显式声明了WebMvcConfigurationSupport类型的Bean
2. 项目中没有使用@EnableWebMvc注解

这两种情况都会导致Spring MVC的默认自动配置被覆盖，从而使springdoc-openapi-ui无法正确注册其所需的资源处理器。

解决方案

方案一：修改WebMvc配置基类

如果项目中自定义了WebMvc配置，建议将配置类从继承WebMvcConfigurationSupport改为继承DelegatingWebMvcConfiguration：

@Configuration
public class WebMvcConfig extends DelegatingWebMvcConfiguration {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        super.addResourceHandlers(registry);  // 必须调用父类方法
        // 添加自定义资源处理器
        registry.addResourceHandler("/custom/**")
                .addResourceLocations("classpath:/custom-resources/");
    }
}

这种修改方式保留了Spring MVC的自动配置机制，同时允许添加自定义配置。

方案二：手动添加资源处理器

如果必须使用WebMvcConfigurationSupport，可以手动添加Swagger UI所需的资源处理器：

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // Swagger UI资源
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springdoc-openapi-ui/")
                .resourceChain(false);
        
        // API文档JSON资源
        registry.addResourceHandler("/v3/api-docs/**")
                .addResourceLocations("classpath:/META-INF/resources/v3/api-docs/");
        
        // 其他自定义资源处理器
        super.addResourceHandlers(registry);
    }
}

方案三：使用@EnableWebMvc注解

在配置类上添加@EnableWebMvc注解可以启用Spring MVC的默认配置，同时保留自定义配置：

@Configuration
@EnableWebMvc
public class WebMvcConfig implements WebMvcConfigurer {
    // 实现自定义配置方法
}

版本兼容性说明

需要注意的是，springdoc-openapi v1.8.0是支持Spring Boot 2.x和1.x的最后一个开源版本。对于需要长期支持的组织，可以考虑获取商业支持。

最佳实践建议

1. 尽量避免直接继承WebMvcConfigurationSupport，除非有特殊需求
2. 在覆盖资源处理器方法时，务必调用父类方法
3. 保持springdoc-openapi-ui版本与Spring Boot版本的兼容性
4. 在生产环境中考虑限制Swagger UI的访问权限

通过以上分析和解决方案，开发者应该能够解决Spring Boot 2.x项目中Swagger UI无法访问的问题，并理解背后的配置原理。