WebAPI数据框架忽略了自定义EnumConverter

Question

我有以下enum和enumConverter：

[TypeConverter(typeof(MyEnumConverter))]
public enum MyEventType {
  Unknown,
  URLEvent
}

public class MyEnumConverter : EnumConverter
{
    public MyEnumConverter(Type type) : base(type)
    {
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string)
        {
            var enumString = (string)value;
            return EnumExtensions.GetValueFromDescription(enumString, EnumType);
        }
        return base.ConvertFrom(context, culture, value);
    }
}

我还有一个WebAPI控制器，该webAPI控制器接受一个对象，该对象包含上述枚举类型的属性：

[Route("api/v1/[controller]")]
[ApiController]
public class TestController : ControllerBase
{
   [Route("events")]
   [HttpPost]
   public IActionResult HandlePost([FromBody] MyEvent myEvent)
   {
       // Do whatever here
   }
}

public class MyEvent 
{
   public MyEventType eventType {get; set;}
}

但是，如果i post {“ eventType”：“ urlevent”}到控制器，我得到一个错误：“无法转换JSON值... convertfrom（）我可以看到它永远不会被调用。

我需要做什么才能使Web API数据限制使用我的EnumConverter？

Answer 1

以下是解决您当前问题的两种替代方法：

第一个：System.Text.json serialization：

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

可以找到该文档在这里。

第二：newtonsoft.json

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson

，然后：

services.AddControllers().AddNewtonsoftJson();

测试结果：