springdoc-openapi 中类型继承映射问题的技术解析

问题背景

在基于Java Spring框架开发RESTful API时，springdoc-openapi是一个广泛使用的库，它能自动生成OpenAPI规范文档。然而，在处理类继承关系时，开发者可能会遇到OpenAPI规范生成不准确的问题，特别是当子类继承父类并添加新属性时。

问题现象

当使用springdoc-openapi为具有继承关系的Java类生成OpenAPI规范时，生成的JSON Schema中required字段的放置位置存在问题。具体表现为：

1. 父类SomeResourceA有一个必填字段propertyA
2. 子类SomeResourceB继承SomeResourceA并添加必填字段propertyB
3. 期望生成的OpenAPI规范中，父类的必填字段应出现在父类Schema中，子类的必填字段应出现在子类Schema中
4. 但实际生成的规范中，所有必填字段都出现在子类Schema的顶层

技术分析

这个问题的根源在于swagger-core库对Java类继承关系的处理方式。当解析带有继承关系的类时：

1. 对于父类，swagger-core能正确识别@NotEmpty等注解，生成包含required字段的Schema
2. 对于子类，它虽然能识别继承关系并使用allOf来表示，但却错误地将父类和子类的所有必填字段都放在子类Schema的顶层

这种生成方式虽然在技术上是合法的OpenAPI规范，但与最佳实践不符，且会导致一些OpenAPI生成器(如TypeScript生成器)无法正确识别子类特有的必填字段。

解决方案

目前有两种可行的解决方案：

1. 使用OpenApiCustomizer进行后处理

可以编写自定义的OpenApiCustomizer来修正生成的Schema：

public class FixInheritanceOpenApiCustomizer implements OpenApiCustomizer {
    @Override
    public void customise(OpenAPI openApi) {
        // 实现逻辑：
        // 1. 遍历所有Schema
        // 2. 识别出使用allOf的复合Schema
        // 3. 分析必填字段来源
        // 4. 将子类特有的必填字段移到对应的子Schema中
        // 5. 从顶层Schema中移除这些字段
    }
}

2. 等待swagger-core修复

这个问题本质上是swagger-core库的问题，可以向swagger-core项目提交issue等待官方修复。在修复前，第一种方案是更可行的临时解决方案。

最佳实践建议

在使用springdoc-openapi处理类继承关系时：

1. 明确定义每个类的@Schema注解，特别是subTypes和allOf属性
2. 为所有必填字段添加合适的验证注解(@NotEmpty, @NotNull等)
3. 考虑编写单元测试验证生成的OpenAPI规范是否符合预期
4. 如果使用TypeScript客户端生成，建议实现上述的修正方案

总结

springdoc-openapi在处理类继承关系时的行为是由底层swagger-core库决定的。虽然当前行为在技术规范上是合法的，但与常见的最佳实践不符，可能导致下游工具链出现问题。开发者可以通过自定义OpenApiCustomizer来解决这个问题，或者等待swagger-core的官方修复。理解这一问题的本质有助于开发者更好地使用springdoc-openapi生成符合预期的API文档。