SpringDoc OpenAPI 2.8.6版本中@ArraySchema描述丢失问题解析

问题背景

在SpringBoot应用中使用SpringDoc OpenAPI库生成API文档时，开发者发现从2.7.0版本升级到2.8.6版本后，DTO类中使用@ArraySchema注解定义的字段描述信息在生成的OpenAPI文档中丢失了。这是一个典型的版本兼容性问题，涉及到OpenAPI规范的核心实现。

问题现象

在DTO类中，当使用如下注解配置时：

@ArraySchema(arraySchema = @Schema(description = "字段描述"))
private List<String> sampleList;

在2.7.0版本中，生成的OpenAPI文档会正确包含字段描述，但在2.8.6版本中，描述信息消失了，只保留了基本的数组类型定义。

技术分析

根本原因

这个问题实际上是上游swagger-core库在支持OpenAPI 3.1规范时引入的回归问题。在实现OAS 3.1支持的过程中，对数组类型Schema的处理逻辑出现了变化，导致通过@ArraySchema定义的描述信息无法正确传递到生成的文档中。

版本差异

• 2.7.0版本默认使用OpenAPI 3.0规范
• 2.8.6版本开始默认使用OpenAPI 3.1规范

影响范围

这个问题会影响所有使用@ArraySchema注解并期望在生成的API文档中显示描述信息的场景。对于简单的@Schema注解，描述信息仍然可以正常显示。

解决方案

临时解决方案

如果需要立即解决问题，可以将OpenAPI规范版本回退到3.0。在application.properties或application.yml中添加以下配置：

springdoc.api-docs.version=openapi_3_0

长期解决方案

等待swagger-core修复这个回归问题。开发者可以关注上游项目的进展，在问题修复后升级到新版本。

最佳实践建议

1. 版本升级策略：在升级SpringDoc OpenAPI版本时，应该先在测试环境验证API文档生成是否正常。

2. 注解使用建议：

   • 对于简单字段，直接使用@Schema注解
   • 对于数组类型，如果描述信息很重要，可以考虑在字段的JavaDoc中也添加描述作为备份

3. 文档验证：建立API文档的自动化测试，验证关键字段的描述信息是否存在于生成的文档中。

总结

这个问题展示了开源组件依赖链中可能出现的兼容性问题。作为开发者，理解底层技术栈的变化对应用功能的影响至关重要。在API文档生成这种看似简单但实际上依赖复杂的技术场景中，保持对版本变更的敏感度可以帮助我们更快地定位和解决问题。

对于生产环境中的关键系统，建议在升级前充分测试，并准备好回滚方案。同时，关注上游项目的issue跟踪可以帮助我们提前发现潜在的兼容性问题。