SpringDoc OpenAPI 2.8.4版本中WebFlux应用Swagger文档路径变更解析

在使用Spring Boot 3.4.2构建WebFlux应用时，开发者可能会遇到一个典型问题：当将springdoc-openapi-starter-webflux-ui从2.8.3升级到2.8.4版本后，访问Swagger UI时意外显示PetStore示例文档而非项目自身的API文档。这一现象背后涉及SpringDoc OpenAPI库的路径配置变更，值得开发者深入了解。

问题现象分析

在2.8.4版本中，开发者通过传统路径/webjars/swagger-ui/index.html访问Swagger UI时，系统会默认加载PetStore示例的API文档（https://petstore.swagger.io/v2/swagger.json），而非预期的项目自身API文档。同时，应用日志中会出现关于静态资源路径的警告信息："Appended trailing slash to static resource location: classpath:/META-INF/resources/webjars/swagger-ui/5.18.2/"。

根本原因

这一变更源于SpringDoc OpenAPI 2.8.4版本对Swagger UI资源路径处理逻辑的调整。新版本中，库的默认行为发生了变化：

1. 移除了对/webjars/swagger-ui/index.html路径的自动配置支持
2. 将默认访问路径简化为/swagger-ui/index.html
3. 未正确关闭/webjars路径下的Swagger UI实例，导致其继续提供PetStore示例

解决方案

要正确访问项目API文档，开发者应采用以下两种方式之一：

1. 使用新路径：直接访问/swagger-ui/index.html
2. 显式配置：在application.yml中指定自定义路径

springdoc:
  swagger-ui:
    path: /webjars/index.html

安全配置建议

为确保Swagger UI和相关API文档可访问，需要在安全配置中明确放行以下路径：

@Bean
public SecurityWebFilterChain filterChain(ServerHttpSecurity http) {
    http.authorizeExchange()
            .matchers(
                    ServerWebExchangeMatchers.pathMatchers("/swagger-ui", "/swagger-ui/*"),
                    ServerWebExchangeMatchers.pathMatchers("/v3/api-docs", "/v3/api-docs/*")
            ).permitAll()
            // 其他安全配置...
    return http.build();
}

版本兼容性说明

这一变更出现在2.8.4版本而非主版本更新中，确实可能让开发者感到意外。在实际项目中，建议：

1. 仔细阅读版本变更日志，即使是小版本更新
2. 在测试环境中充分验证Swagger功能后再进行生产部署
3. 考虑在团队内部文档中记录此类配置变更

日志警告处理

关于静态资源路径的警告信息，虽然不影响功能，但可以通过以下方式消除：

1. 等待后续版本修复（已在社区提交相关问题）
2. 临时调整日志级别，过滤特定警告

最佳实践建议

1. 在Spring Boot WebFlux项目中，优先使用/swagger-ui/index.html路径
2. 在API网关或反向代理层统一Swagger访问路径
3. 考虑在CI/CD流程中加入Swagger功能测试，确保文档生成正常

通过理解这些变更背后的设计思路，开发者可以更好地适应SpringDoc OpenAPI库的演进，并构建更健壮的API文档系统。