Orval项目中如何生成真正的TypeScript枚举类型

Orval是一个用于从OpenAPI/Swagger规范生成TypeScript代码的工具。在实际使用过程中，开发者发现Orval默认生成的枚举类型并非真正的TypeScript枚举，而是使用const对象模拟的枚举结构。

枚举生成的现状与问题

当前版本的Orval(6.23.0)默认会为OpenAPI中的enum定义生成如下代码：

export type Color1 = (typeof Color1)[keyof typeof Color1];

export const Color1 = {
  black: "black",
  white: "white",
  red: "red",
  green: "green",
  blue: "blue",
} as const;

这种实现方式虽然能够提供类型安全，但与TypeScript原生的枚举类型相比存在一些不足：

1. 不是真正的枚举语法，代码可读性较差
2. 需要额外的类型定义来获取枚举值类型
3. 在使用体验上不如原生枚举直观

解决方案：启用真正的TypeScript枚举

从Orval 6.21.0版本开始，已经支持生成真正的TypeScript枚举。开发者可以通过配置启用这一功能。正确的枚举生成结果应该如下：

export enum Color1 {
  black = "black",
  white = "white",
  red = "red",
  green = "green",
  blue = "blue",
}

使用x-enumNames时的注意事项

当OpenAPI规范中使用x-enumNames扩展属性为数值枚举指定名称时，Orval当前版本(6.23.0)存在一个小问题：生成的枚举会错误地使用冒号(:)而不是等号(=)作为键值分隔符。

例如对于以下OpenAPI定义：

Color2:
  type: number
  enum:
    - 0
    - 10
    - 20
    - 30
    - 40
  x-enumNames:
    - black
    - white
    - red
    - green
    - blue

当前会生成：

export enum Color2 {
  black: 0,
  white: 10,
  red: 20,
  green: 30,
  blue: 40,
}

正确的语法应该是使用等号：

export enum Color2 {
  black = 0,
  white = 10,
  red = 20,
  green = 30,
  blue = 40,
}

最佳实践建议

1. 对于新项目，建议启用Orval的TypeScript枚举生成功能
2. 使用x-enumNames时，注意检查生成的枚举语法是否正确
3. 字符串枚举和数值枚举在TypeScript中有不同的使用场景，根据实际需求选择合适的类型
4. 在团队协作中，确保所有成员了解生成的枚举类型及其用法

通过正确配置Orval，开发者可以获得更符合TypeScript习惯的枚举定义，提高代码的可读性和维护性。