3

我正在使用 NSwag SwaggerToCSharpClientGenerator 生成请求和响应类和枚举。

我有一些 Web API 方法与参数或请求对象共享相同的枚举。当我运行 NSwag API 时,它多次生成相同的枚举定义,但命名为 Enum1、Enum2、Enum3、ResponseClassEnum。

我可以配置 NSwag(或 Swashbuckle)以便只生成一个枚举吗?

我的 NSwag 代码如下所示:

   var document = SwaggerDocument.FromUrlAsync(
      "http://localhost:5003/swagger/v1/swagger.json").Result;

   var settings = new SwaggerToCSharpClientGeneratorSettings();
   settings.GenerateClientClasses = false;
   settings.CSharpGeneratorSettings.Namespace = "My.Interface";
   settings.CSharpGeneratorSettings.ArrayType = "List";
   settings.AdditionalNamespaceUsages = new string[] { "System.Collections.Generic" };
   settings.GenerateExceptionClasses = false;

   var generator = new SwaggerToCSharpClientGenerator(document, settings);

   var code = generator.GenerateFile();
   File.WriteAllText("Swagger.MyApi.cs", code);

我在这里放了混淆的 swagger.json - https://pastebin.com/hT5ySZub

从混淆的 swagger.json 生成的输出在这里 - https://pastebin.com/e0AYJWer 在输出中,类型 DupEnum 定义在以下类型中:DupEnum、DupEnum2、DupEnum3 和 TypeBDupEnum。

4

1 回答 1

6

您可能正在使用 swashbuckle 生成 swagger 规范:问题是 Swashbuckle 不引用枚举而是重复它们 - 这就是它们被多次生成的原因(参见:https ://github.com/RSuter/NJsonSchema/issues/17 ) .

如果规范是使用 NSwag 生成的,那么枚举会使用特殊属性(x-schema)引用,并且生成的代码不包含任何重复项。

根本问题是 Swagger 规范 - 它不允许在原始参数中引用枚举......而且我什至不确定这是否已在 OpenAPI 3 中修复。

于 2017-09-19T14:47:18.743 回答