使用JSON.net将枚举容器序列化为字符串

时间:2013-09-05 15:18:38

标签: c# asp.net-web-api json.net

您可以通过添加属性来将WebAPI模型中的枚举字段序列化为字符串:

enum Size
{
    Small,
    Medium,
    Large
}

class Example1
{
    [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
    Size Size { get; set; }
}

这将序列化为此JSON:

{
  "Size": "Medium"
}

如何为枚举集合完成相同的操作?

class Example2
{
    IList<Size> Sizes { get; set; }
}

我想序列化为这个JSON:

{
  "Sizes":
  [
    "Medium",
    "Large"
  ]
}

2 个答案:

答案 0 :(得分:78)

您需要使用JsonPropertyAttribute.ItemConverterType属性:

class Example2
{
    [JsonProperty (ItemConverterType = typeof(StringEnumConverter))]
    public IList<Size> Sizes { get; set; }
}

答案 1 :(得分:15)

我在我的网络应用程序的启动代码中有这个将所有枚举序列化为字符串(我更喜欢将枚举名称传递给值,使事情更加健壮)。

必须承认我从来没有在枚举列表上尝试过,但我不知道它会怎么做 - 可能值得一试。

var jsonFormatter = config.Formatters.JsonFormatter;
jsonFormatter.SerializerSettings.Converters.Add(new StringEnumConverter { CamelCaseText = true });