NET MVC 核心 API 将枚举序列化为字符串

小开

最佳答案

新系统。文本。 Json 序列化

NET MVC Core 3.0使用内置的 JSON 序列化，使用 System.Text.Json.Serialization.JsonStringEnumConverter(带“ JSON”前缀) :

services
.AddMvc()
// Or .AddControllers(...)
.AddJsonOptions(opts =>
{
var enumConverter = new JsonStringEnumConverter();
opts.JsonSerializerOptions.Converters.Add(enumConverter);
})

更多信息给你。文档可以找到给你。

如果你喜欢牛顿软件的话

你也可以使用“传统的”Newton. Json 系列:

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson

然后:

services
.AddControllers()
.AddNewtonsoftJson(opts => opts
.Converters.Add(new StringEnumConverter()));

小开

一些补充:
如果使用 < strong > Newton soft. Json

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson

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

选项。序列化设置。转换器

SerializerSettings是必要的

小开

如果你有一个 Minimal API这将是有用的:

using System.Text.Json.Serialization;


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

小开

如果你正在使用 Aspnet Core MVC 和最小的 API，请使用下面的代码:

services.Configure<Microsoft.AspNetCore.Mvc.JsonOptions>(o => o.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));