NSwag 中 C 枚举到 TypeScript 枚举的正确转换方法

在使用 NSwag 进行 C# 到 TypeScript 的代码生成时，枚举类型的转换是一个常见需求。本文将详细介绍如何正确配置 NSwag，确保 C# 枚举能够按照预期转换为 TypeScript 枚举。

问题背景

在从 NSwag 13.x 升级到 14.x 版本后，许多开发者发现枚举的生成方式发生了变化。原本期望的枚举转换结果如：

export enum ChronoUserPersonalRights {
    NoRights = 0,
    ReadWrite = 1,
    ReadOnly = 2,
}

变成了不符合预期的格式：

export enum ChronoUserPersonalRights {
    _0 = 0,
    _1 = 1,
    _2 = 2,
}

解决方案

要解决这个问题，需要进行以下配置：

1. 服务端配置

在 ASP.NET Core 的 Startup.cs 文件中添加 JSON 序列化选项，确保枚举值以字符串形式序列化：

services.AddControllersWithViews().AddJsonOptions(o =>
    o.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter())
);

2. NSwag 配置调整

在 NSwag 配置文件中，确保 enumStyle 设置为 "Enum"：

"enumStyle": "Enum"

3. 完整配置示例

以下是一个完整的 NSwag 配置示例，确保枚举正确转换：

{
  "runtime": "Net80",
  "codeGenerators": {
    "openApiToTypeScriptClient": {
      "className": "{controller}Client",
      "typeScriptVersion": 2.7,
      "template": "Angular",
      "promiseType": "Promise",
      "dateTimeType": "String",
      "nullValue": "Undefined",
      "generateClientClasses": false,
      "generateClientInterfaces": false,
      "exportTypes": true,
      "generateDtoTypes": true,
      "operationGenerationMode": "MultipleClientsFromOperationId",
      "typeStyle": "Interface",
      "enumStyle": "Enum",
      "generateDefaultValues": true
    }
  }
}

深入理解

为什么会出现这个问题？

NSwag 14.x 版本对枚举处理进行了改进，默认行为发生了变化。新版本更严格地遵循 OpenAPI/Swagger 规范，而旧版本则有一些特殊的处理逻辑。

枚举处理的两种模式

1. 数值模式：保留原始的数字值
2. 字符串模式：使用枚举成员名称

通过添加 JsonStringEnumConverter，我们告诉系统使用字符串模式序列化枚举，这样 NSwag 就能正确识别并生成对应的 TypeScript 枚举定义。

最佳实践

1. 始终在服务端明确指定枚举的序列化方式
2. 在 NSwag 配置中显式设置 enumStyle
3. 对于复杂的枚举场景，考虑使用自定义转换器
4. 升级 NSwag 版本时，注意检查枚举生成结果

总结

通过正确的服务端配置和 NSwag 设置，可以确保 C# 枚举能够按照预期转换为 TypeScript 枚举。关键在于理解 NSwag 的工作原理，并在服务端和客户端生成工具中做出相应的配置调整。