ASP .NET Core 设置枚举请求和返回使用字符串而非数字

在日常开发中，我们经常会遇到需要传参和返回枚举值，默认情况下我们使用数值，需要双方约定好各种数值代表什么。这样的表示并不明确，无法见名知意。所以我们有没有办法让传参变成字符串，并且我们还能正确转换成枚举值呢？答案是可以。
用原生的JsonStringEnumConverter或者Newtonsoft.Json的StringEnumConverter都可以实现。
以下使用原生的JsonStringEnumConverter说明，只需要在Program.cs添加如下配置即可。

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

根据JsonStringEnumConverter 类的说明，JsonStringEnumConverter可以将枚举值转换为字符串以及从字符串转换为枚举值，并且支持自定义属性名称和值。
如果想使用Newtonsoft.Json，可以参考JsonConverter Attribute in ASP.NET Core 3.0 Web API。

接下来写两个接口用于测试

[HttpGet(nameof(GetEnum))]
public ActionResult<TeacherDto> GetEnum()
{
    return Ok(new TeacherDto()
    {
        Id = Guid.NewGuid().ToString(),
        Age = 23,
        Name = "teacher 1",
        TeacherLevel = TeacherLevel.Assistant
    });
}

[HttpPost(nameof(PostEnum))]
public IActionResult PostEnum([FromBody] TeacherDto teacherDto)
{
    return Ok($"The value of TeacherLevel is {teacherDto.TeacherLevel}");
}

效果如下

示例代码

Program
EnumTestController
TeacherLevel

参考资料

JsonConverter Attribute in ASP.NET Core 3.0 Web API
JavaScriptSerializer - JSON serialization of enum as string