SpringCodegen从YAML生成枚举时命名异常的解决咨询

在OpenAPI YAML中定义如下枚举：

SchemeEnum:
  type: string
  enum:
    - SCHEME_I
    - SCHEME_II

通过Spring Codegen生成的Java枚举却变成：

public enum SchemeEnum {
    I("SCHEME_I"),
    II("SCHEME_II");
    // 构造方法等省略
}

期望生成的枚举项保留原枚举值：

public enum SchemeEnum {
    SCHEME_I("SCHEME_I"),
    SCHEME_II("SCHEME_II");
    // 构造方法等省略
}

但当YAML中新增SCHEME枚举值后，生成的枚举类显示正常：

SchemeEnum:
  type: string
  enum:
    - SCHEME
    - SCHEME_I
    - SCHEME_II

生成结果：

public enum SchemeEnum {
    SCHEME("SCHEME"),
    SCHEME_I("SCHEME_I"),
    SCHEME_II("SCHEME_II");
    // 构造方法等省略
}

这是Spring Codegen默认枚举命名策略导致的：当所有枚举值带有相同前缀（比如此处的SCHEME_）时，工具会自动移除公共前缀生成枚举项名称。可通过以下两种方式调整：

1. 修改Codegen配置参数 #

添加enumPropertyNaming=original参数，强制工具保留枚举值原始名称，不自动移除公共前缀。

• Maven插件配置：

<plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <version>你的版本号</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>
                <!-- 其他配置 -->
                <configOptions>
                    <enumPropertyNaming>original</enumPropertyNaming>
                </configOptions>
            </configuration>
        </execution>
    </executions>
</plugin>

• 命令行工具使用：

openapi-generator generate -g spring -i your-spec.yaml -o output-dir --additional-properties enumPropertyNaming=original

2. 在OpenAPI YAML中使用x-enum-varnames扩展 #

在枚举定义中显式指定每个枚举项对应的Java变量名，覆盖默认命名策略：

SchemeEnum:
  type: string
  enum:
    - SCHEME_I
    - SCHEME_II
  x-enum-varnames:
    - SCHEME_I
    - SCHEME_II

此时Codegen会直接使用x-enum-varnames中定义的名称作为枚举项名称，不会自动处理前缀。

内容的提问来源于stack exchange，提问作者Lulex97