SpringDoc OpenAPI 2.8.0版本中@ArraySchema注解行为变更解析

问题背景

在Spring生态系统中，SpringDoc OpenAPI是一个广泛使用的库，用于自动生成基于Spring Boot应用的API文档。近期发布的2.8.0版本中，对@ArraySchema注解的处理方式进行了调整，这导致了一些开发者在使用过程中遇到了文档生成不一致的问题。

现象描述

在2.8.0版本之前，当开发者使用@ArraySchema注解标注一个包含自定义DTO的List类型字段时，生成的OpenAPI文档能够正确引用该DTO的定义。例如：

public record XxxCreateReq(
    @ArraySchema(schema = @Schema(description = "Schema Description"))
    List<XxxDto> fields
) {}

在2.7.0及更早版本中，生成的文档会包含对XxxDto的正确引用：

"properties": {
    "fields": {
        "type": "array",
        "items": {
            "$ref": "xxx.xxx.XxxDto"
        }
    }
}

然而，在升级到2.8.0后，相同的代码生成的文档中缺少了$ref引用，仅保留了描述信息：

"properties": {
    "fields": {
        "type": "array",
        "items": {
            "description": "Schema Description"
        }
    }
}

根本原因

这一行为变化实际上是由于SpringDoc OpenAPI 2.8.0版本将默认的OpenAPI规范版本从3.0.1升级到了3.1.0。不同版本的OpenAPI规范对注解的处理方式存在差异，特别是在处理数组类型和引用时。

解决方案

开发者可以通过以下两种方式解决这个问题：

方案一：调整注解使用方式

// 方式1：使用arraySchema属性替代schema属性
@ArraySchema(arraySchema = @Schema(description = "Schema Description"))
List<XxxDto> fields

// 方式2：在Schema注解中明确指定实现类
@ArraySchema(schema = @Schema(description = "Schema Description", implementation = XxxDto.class))
List<XxxDto> fields

方案二：回退到OpenAPI 3.0.1规范

在应用配置中添加以下属性：

springdoc.api-docs.version=openapi_3_0

这将强制SpringDoc使用3.0.1版本的OpenAPI规范，保持与之前版本一致的行为。

技术建议

1. 明确指定实现类：在使用@ArraySchema时，建议总是通过implementation属性明确指定数组元素的类型，这样可以避免规范版本变化带来的不一致性。

2. 版本兼容性检查：在升级SpringDoc版本时，应当仔细检查变更日志，特别是涉及规范版本升级的情况，提前评估对现有API文档的影响。

3. 测试验证：对于重要的API文档生成，建议在升级后进行全面测试，确保生成的文档符合预期。

总结

SpringDoc OpenAPI 2.8.0版本的这一变化提醒我们，在依赖自动生成的API文档时，需要关注底层规范的版本差异。通过合理配置和明确的注解使用，可以确保在不同环境下都能生成一致的API文档。对于需要保持向后兼容性的项目，暂时使用OpenAPI 3.0.1规范可能是一个稳妥的选择。