SpringDoc OpenAPI 中抽象类Javadoc文档缺失问题解析

在基于SpringDoc OpenAPI的项目开发中，开发者经常会遇到一个典型问题：当使用抽象类作为模型基类时，基类上的Javadoc注释无法正确显示在生成的Swagger文档中。本文将深入分析该问题的成因，并提供完整的解决方案。

问题现象

当开发者定义如下类结构时：

1. 抽象基类Question标注了详细的Javadoc注释
2. 具体子类TestQuestion和TextQuestion继承该基类
3. 控制器中使用包含Question列表的Test类作为参数

生成的Swagger UI界面中，子类的Javadoc能够正常显示，但基类的文档描述却完全缺失。这种表现与开发者预期不符，特别是当基类包含重要公共属性说明时。

技术背景

SpringDoc OpenAPI通过以下机制处理模型文档：

1. 默认会扫描类上的Javadoc注释
2. 对于继承结构，会递归处理类层次关系
3. 使用Jackson的@JsonTypeInfo处理多态序列化

在抽象类场景下，文档生成存在特殊处理逻辑：

• 当抽象类直接作为方法参数/返回值时，文档生成正常
• 当抽象类作为其他类的成员属性时，文档生成存在缺陷

根本原因

经过分析，问题根源在于：

1. 类型解析器对嵌套属性的处理不完整
2. 文档生成器未正确遍历继承树的所有层级
3. 对Jackson多态注解的特殊处理影响了文档收集

解决方案

方案一：显式使用@Schema注解

最可靠的解决方式是显式标注Schema信息：

@Schema(description = "base class for all questions in test with polymorphism")
public abstract class Question {
    // 类实现
}

方案二：配置增强扫描

在application.properties中添加：

springdoc.model-converters.deprecating-converter.enabled=true
springdoc.show-abstract-classes-in-model=true

方案三：自定义ModelConverter

实现自定义ModelConverter来增强抽象类处理：

@Bean
public ModelResolver modelResolver(OpenAPI openAPI) {
    return new ModelResolver(openAPI) {
        @Override
        protected Schema resolve(AnnotatedType type) {
            Schema schema = super.resolve(type);
            if (schema != null && type.getType() instanceof Class) {
                Class<?> cls = (Class<?>) type.getType();
                if (Modifier.isAbstract(cls.getModifiers())) {
                    schema.setDescription(extractJavadoc(cls));
                }
            }
            return schema;
        }
    };
}

最佳实践建议

1. 重要抽象类始终使用@Schema显式标注
2. 对于多态结构，确保每个子类都有完整文档
3. 定期检查生成的OpenAPI文档完整性
4. 考虑在CI流程中加入文档校验步骤

版本兼容性说明

该问题在以下版本中表现不同：

• 2.6.0版本：存在描述缺失问题
• 2.7.0+版本：部分改进但仍建议显式标注
• 3.0.0版本：对继承处理有显著优化

建议根据项目实际情况选择合适的版本和解决方案。对于关键API文档，采用显式Schema标注是最可靠的跨版本解决方案。