ASP.NET MVC Core 3.0 API将枚举序列化为字符串

Question

如何在ASP.NET MVC Core 3.0中将Enum字段序列化为String而不是Int？我不能用旧的方式做。

services.AddMvc().AddJsonOptions(opts =>
{
    opts.JsonSerializerOptions.Converters.Add(new StringEnumConverter());
})

我收到一个错误：

无法从“ Newtonsoft.Json.Converters.StringEnumConverter”转换为“ System.Text.Json.Serialization.JsonConverter”

Answer 1

如果你有一个，Minimal API这将会很有用：

using System.Text.Json.Serialization;

builder.Services.Configure<Microsoft.AspNetCore.Http.Json.JsonOptions>(opt =>
{
    opt.SerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

Answer 2

.NET 7.0引入了这样的方式：

builder.Services.ConfigureHttpJsonOptions(options => options.SerializerOptions.Converters.Add(new JsonStringEnumConverter()));

Answer 3

一些补充：
如果使用Newtonsoft.Json

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson

services
    .AddControllers()
    .AddNewtonsoftJson(options =>
        options.SerializerSettings.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter()));

options.SerializerSettings.Converters

SerializerSettings 是必要的

Answer 4

ASP.NET MVC Core 3.0使用内置的JSON序列化。使用System.Text.Json.Serialization.JsonStringEnumConverter（带有“ Json”前缀）：

services.AddMvc().AddJsonOptions(opts =>
{
    opts.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
})

更多信息在这里。该文档可在此处找到。