SpringDoc OpenAPI中自定义类型字段描述丢失问题解析与解决方案

在Spring Boot应用开发过程中，SpringDoc OpenAPI作为流行的API文档生成工具，能够自动将代码中的注解转换为OpenAPI规范文档。然而，当开发者使用自定义类型作为DTO字段时，可能会遇到字段级描述信息丢失的问题。

问题现象分析

当开发者在DTO类中使用自定义类型字段并添加@Schema注解时，例如：

public class SharedCustomIdRequestDto {
    @Schema(description = "request dto custom long id")
    private CustomLongId requestCustomLongId;
}

@Schema(description = "Custom Long id")
public class CustomLongId {
    private String value;
}

期望生成的OpenAPI文档应包含字段级描述信息，但实际生成的文档中该描述信息丢失，仅显示对自定义类型的引用：

"requestCustomLongId": {
    "$ref": "#/components/schemas/CustomLongId",
    "description": null
}

技术背景

这个问题源于OpenAPI规范本身的设计。在OpenAPI 3.0版本中，当使用$ref引用其他模式定义时，规范要求忽略所有同级属性。这意味着当字段被解析为引用类型时，其字段级的描述、示例等附加属性都会被忽略。

解决方案探讨

1. 使用PropertyCustomizer扩展点

SpringDoc提供了PropertyCustomizer接口，允许开发者在生成文档时对属性进行自定义处理。虽然无法直接获取丢失的描述信息，但可以通过此接口实现一些变通方案。

2. 升级到OpenAPI 3.1

OpenAPI 3.1规范解决了引用类型同级属性被忽略的问题。如果项目环境允许，可以考虑：

1. 确保使用的swagger-core版本支持OpenAPI 3.1
2. 配置SpringDoc使用3.1版本的OpenAPI规范

3. 重构DTO设计

作为替代方案，可以考虑以下重构方式：

• 避免在自定义类型字段上使用@Schema注解
• 将描述信息移至自定义类型本身的类注释中
• 使用组合而非继承来保持文档清晰性

最佳实践建议

1. 对于简单场景，优先考虑将描述信息放在自定义类型定义中
2. 对于需要字段级描述的复杂场景，评估升级到OpenAPI 3.1的可行性
3. 保持文档注释的一致性和完整性，避免过度依赖工具自动生成

总结

SpringDoc OpenAPI在处理自定义类型字段描述时存在局限性，这主要是由于底层OpenAPI规范的限制。开发者可以通过了解规范细节、使用扩展点或升级规范版本来解决这一问题。在实际项目中，应根据具体需求和环境约束选择最适合的解决方案。

理解这些底层机制不仅能帮助解决当前问题，还能让开发者在设计API时做出更明智的架构决策，从而产生更清晰、更易维护的API文档。