使用OpenAPI 2.0鉴别器时Swagger与Jackson序列化兼容问题求助

我碰到过不少开发者在OpenAPI 2.0里用鉴别器（discriminator）时，都会撞上Swagger工具和Jackson序列化器的需求冲突——就像你说的，Jackson序列化后会冒出两个鉴别器JSON属性，其中一个还带着null值。咱们先拆解下问题根源，再一步步解决。

问题根源分析 #

OpenAPI 2.0的鉴别器机制和Jackson的多态序列化逻辑天生有点“不对付”：

• Swagger工具要求鉴别器字段必须关联到父类（比如你的GeneralError），用来区分不同子类（比如SpecificError）；
• 但Jackson的@JsonTypeInfo注解默认会在序列化子类时，把类型标识字段直接写入子类的JSON结构。如果父类也显式定义了这个字段，就会导致序列化时同时出现父类的空值字段和子类的实际值字段。

从你给出的OpenAPI定义片段来看，应该是父类GeneralError里声明了鉴别器字段，同时Jackson配置又在子类或全局开启了多态类型标识，才触发了这个重复字段的问题。

具体解决方案 #

1. 调整OpenAPI定义，适配Swagger与Jackson的共同要求 #

修改OpenAPI 2.0定义，让鉴别器字段只在子类中固定值，父类仅指定鉴别器的字段名（不定义实体字段）：

swagger: '2.0'
info:
  version: v1
  title: Error API
paths:
  /errors:
    get:
      description: Stack Overflow test
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/SpecificError'
definitions:
  GeneralError:
    type: object
    discriminator: errorType  # 仅指定鉴别器字段名，不定义该字段
    properties:
      message:
        type: string
  SpecificError:
    allOf:
      - $ref: '#/definitions/GeneralError'
      - type: object
        properties:
          errorType:
            type: string
            enum: [SpecificError]  # 子类固定鉴别器值
          details:
            type: string

2. 配置Jackson注解，避免重复生成字段 #

在Java代码中，给父类和子类添加针对性的Jackson注解，确保只生成一个鉴别器字段：

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;

// 父类指定类型标识规则，不定义errorType属性
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "errorType")
public abstract class GeneralError {
    private String message;
    // getter/setter方法
}

// 子类固定类型名称，不手动定义errorType字段
@JsonTypeName("SpecificError")
public class SpecificError extends GeneralError {
    private String details;
    // getter/setter方法
}

这里的核心是：

• 父类只通过注解声明类型标识规则，不创建errorType的实体属性；
• 子类用@JsonTypeName固定类型值，让Jackson自动生成该字段，避免手动定义导致的重复。

3. 双向兼容性验证 #

调整后：

• Swagger工具能正确识别errorType作为鉴别器，关联SpecificError的类型值；
• Jackson序列化时只会生成一个errorType字段，值为SpecificError，不会出现带null的重复字段。

额外注意事项 #

• 如果用Swagger Codegen生成代码，要确保生成器配置和上述Jackson注解逻辑一致，可通过--additional-properties参数指定注解生成规则；
• 绝对避免在父类和子类中同时定义鉴别器字段，这是导致重复null字段的核心原因。

内容的提问来源于stack exchange，提问作者Marcel Stör