NSwag 将 x-enum-varnames 标签添加到所有枚举

Question

是否可以将 x-enum-varnames 添加到 NSwag 中的所有枚举？我有这个例子，但是你必须指定所有的枚举。有更通用的解决方案吗？另外，这个例子创建了第二个实例 ResultCode2 我不明白。

https://github.com/RicoSuter/NSwag/issues/1993

public class NSwagProcessor : IOperationProcessor
{
    public bool Process( OperationProcessorContext context )
    {
        JsonSchema schema = JsonSchema.FromType<ResultCode>();
        if( schema.ExtensionData == null )
        {
            schema.ExtensionData = new Dictionary<string, object>();
        }

        string[] enumerationNames = new string[ schema.EnumerationNames.Count ];
        schema.EnumerationNames.CopyTo( enumerationNames, 0 );
        schema.ExtensionData.Add( "x-enum-varnames", enumerationNames );

        if( context.Settings.TypeMappers.Any( t => t.MappedType == typeof( ResultCode ) ) == false )
        {
            context.Settings.TypeMappers.Add( new ObjectTypeMapper( typeof( ResultCode ), schema ) );
        }

        return true;
    }
}

...

services.AddOpenApiDocument( config => {
    config.OperationProcessors.Add( new NSwagProcessor() );
} );

这将创建：

"ResultCode": {
    "type": "integer",
    "description": "",
    "x-enumNames": [
      "Error",
      "Success"
    ],
    "enum": [
      0,
      1
    ]
  },

...

"ResultCode2": {
    "title": "ResultCode",
    "type": "integer",
    "description": "",
    "x-enumNames": [
      "Error",
      "Success"
    ],
    "enum": [
      0,
      1
    ],
    "x-enum-varnames": [
      "Error",
      "Success"
    ]
  },

Answer 1

我认为对我来说最好的解决方案是将 json 枚举序列化设置为字符串：

services.AddControllers().AddJsonOptions( options =>
{
    options.JsonSerializerOptions.Converters.Add( new JsonStringEnumConverter() );
});

Answer 2

我找到了另一个解决方案，你可以在 NSwag openapi 生成中添加一个 Schema processor。通过添加以下架构处理器：

public class XEnumVarnamesNswagSchemaProcessor : ISchemaProcessor
{
    public void Process(SchemaProcessorContext context)
    {
        if (context.Type.IsEnum)
        {
            if (context.Schema.ExtensionData is not null)
            {
                context.Schema.ExtensionData.Add("x-enum-varnames", context.Schema.EnumerationNames.ToArray());
            }
            else
            {
                context.Schema.ExtensionData = new Dictionary<string, object>()
                {
                    {"x-enum-varnames", context.Schema.EnumerationNames.ToArray()}
                };
            }
        }
    }
}

将向所有 openapi 枚举添加一个额外字段 schemas/types。您需要在 Startup.cs.

中将处理器添加到 NSwag 服务中

services.AddOpenApiDocument(configuration =>
        {
            configuration.SchemaProcessors.Add(new XEnumVarnamesNswagSchemaProcessor());
        });

NSwag 将 x-enum-varnames 标签添加到所有枚举

NSwag add x-enum-varnames tag to all enums

.net-core

openapi

openapi-generator

nswag