NestJS Swagger模块中x-enumNames失效问题分析与解决方案

问题背景

在NestJS Swagger模块从7.x升级到8.0.0及以上版本后，开发者反馈x-enumNames扩展属性不再生效。这个属性原本用于在生成的OpenAPI/Swagger文档中为枚举值指定可读的名称，对于客户端代码生成非常重要。

问题表现

当开发者使用如下装饰器定义枚举属性时：

@ApiProperty({
  enum: CreditCardDealType,
  enumName: 'CreditCardDealType',
  'x-enumNames': ['REGULAR', 'PAYMENTS'],
})
cardDealType?: CreditCardDealType;

期望生成的OpenAPI文档中枚举值应保持原始名称：

export enum CreditCardDealType {
  REGULAR = 1,
  PAYMENTS = 2,
}

但实际生成的却是：

export enum CreditCardDealType {
  Value1 = 1,
  Value2 = 2,
}

技术分析

这个问题源于8.0.0版本中对createEnumSchemaType函数的重构。在重构过程中，x-enumNames属性的处理逻辑可能被遗漏或修改，导致该扩展属性不再被正确识别和应用。

在Swagger/OpenAPI规范中，x-enumNames是一个常用的扩展属性，用于为数值枚举提供可读的名称。当客户端代码生成工具（如NSwag、Swagger Codegen等）处理API定义时，会使用这些名称来生成更友好的枚举类型。

解决方案

目前官方已将此问题标记为已关闭，并在PR #3307中进行了跟踪处理。对于遇到此问题的开发者，可以采取以下临时解决方案：

1. 降级使用7.3.1版本：在package.json中使用overrides指定Swagger模块版本

2. 等待官方修复：关注PR #3307的进展，待修复发布后升级到新版本

3. 自定义装饰器：可以创建一个自定义装饰器来临时解决这个问题

最佳实践建议

1. 编写测试用例：对于Swagger文档生成这类功能，建议编写自动化测试来验证生成的OpenAPI文档是否符合预期

2. 版本升级验证：在升级主要版本时，应全面测试Swagger文档生成功能

3. 关注变更日志：仔细阅读版本变更日志，了解可能影响现有功能的改动

总结

这个问题提醒我们在使用框架扩展功能时需要注意版本兼容性。x-前缀的扩展属性虽然方便，但也可能在不同版本间存在支持差异。开发者在使用时应确保测试覆盖，并在升级时进行充分验证。