SpringDoc OpenAPI 中静态资源加载问题的分析与解决方案

问题背景

在使用SpringDoc OpenAPI项目时，开发者可能会遇到一个常见问题：当访问swagger-ui界面时，系统返回"404 Not Found"错误，提示"No static resource swagger-ui/index.html"。这个问题在Spring Boot 3.x与SpringDoc 2.x版本组合中尤为常见。

问题现象

开发者通常会遇到以下表现：

• /v3/api-docs端点可以正常工作，返回正确的OpenAPI规范文档
• /swagger-ui/index.html或/swagger-ui.html端点返回404错误
• 错误信息明确指出无法找到静态资源

根本原因分析

经过对多个开发者反馈的分析，这个问题可能由以下几个因素导致：

1. 版本兼容性问题：SpringDoc不同版本与Spring Boot版本的兼容性存在差异
2. 资源处理配置：自定义的WebMvc配置可能覆盖了SpringDoc的默认资源处理逻辑
3. 构建工具缓存：Maven或Gradle的缓存可能导致资源未被正确打包
4. 上下文路径配置：应用配置的context-path可能影响资源路径解析

解决方案

1. 版本选择

根据开发者反馈，以下版本组合被证实可以正常工作：

• Spring Boot 3.x + SpringDoc 2.1.0
• Spring Boot 3.x + SpringDoc 2.2.0
• Spring Boot 3.x + SpringDoc 2.5.0

建议开发者根据实际Spring Boot版本选择合适的SpringDoc版本。

2. 资源处理配置

对于自定义了WebMvc配置的应用，需要显式添加Swagger UI的资源处理器：

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    
    private final SwaggerIndexTransformer swaggerIndexTransformer;

    public WebMvcConfig(SwaggerIndexTransformer swaggerIndexTransformer) {
        this.swaggerIndexTransformer = swaggerIndexTransformer;
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger-ui*/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/")
                .resourceChain(false)
                .addTransformer(swaggerIndexTransformer);
    }
}

3. 构建工具处理

如果问题仍然存在，可以尝试以下步骤：

1. 清理IDE缓存（IntelliJ IDEA的"Invalidate Caches"功能）
2. 执行mvn clean install或gradle clean build
3. 删除本地Maven仓库中的相关依赖，强制重新下载

4. 上下文路径处理

如果应用配置了自定义上下文路径（如server.servlet.context-path=/app），需要确保访问路径包含该上下文：

• 正确路径：/app/swagger-ui/index.html
• 错误路径：/swagger-ui/index.html

替代访问方式

在某些情况下，可以直接访问webjars路径： /webjars/swagger-ui/index.html

这种方式绕过了SpringDoc的默认重定向逻辑，直接访问打包在webjars中的Swagger UI资源。

最佳实践建议

1. 版本一致性：确保Spring Boot与SpringDoc版本兼容
2. 配置检查：避免不必要的WebMvc配置覆盖
3. 构建验证：定期执行清理构建操作
4. 路径测试：同时测试/v3/api-docs和Swagger UI路径

总结

SpringDoc OpenAPI的静态资源加载问题通常不是功能缺陷，而是配置或版本选择不当导致的。通过合理选择版本、正确配置资源处理器以及保持构建环境清洁，大多数情况下可以顺利解决这一问题。对于复杂的应用场景，建议采用渐进式调试方法，从简单配置开始逐步添加功能，以便快速定位问题根源。