REST API包装器设计:将动态json作为JSON.NET JObject / JArray返回

时间:2014-04-05 10:40:27

标签: c# json api rest json.net

我正在为RESTful JSON API编写一个C#包装器,并使用Json.NET将传入的json反序列化为强类型对象。但是传入json中的一些属性是高度动态的,它将是一些具有不同数量和类型属性的json对象。我目前的解决方案是,我将动态json属性映射到我的C#类中的Dictionary<string, object>(嵌套字典),并编写Custom JsonConverter将动态json转换为嵌套字典。我的班级看起来像这样:

public class Item
{
  [JsonProperty("item_id")]
  public int ItemId { get; set; }

  [JsonProperty("type")]
  public string Type { get; set; }

  //Property to map dynamic json object
  [JsonProperty("data")]
  public Dictionary<string, object> Data { get; set; }
}

成功了。

问题是,很难从最终用户的嵌套字典中访问数据,我们甚至无法在Visual Studio中调试数据的结构。现在我计划使用JObjectJArray而不是嵌套字典。这样我们就可以通过调用ToString方法(将原始的json数据输出为字符串)来查看数据结构,以及这些类型具有LINQ支持,以便用户可以轻松地从中访问数据。

这是一个很好的做法,考虑JObjectJArray类型都依赖于第三方库(无论如何Json.NET是我的库的依赖,因为我用它来进行json序列化)。还是有其他方法可以做到这一点?

1 个答案:

答案 0 :(得分:2)

您应该使用ExpandoObjectConverter代替。

您需要将IDictionary<string, object>键入dynamic,并使用[JsonConverter(typeof(ExpandoObjectConverter))]修饰整个媒体资源。

一个有趣的细节是ExpandoObject也实现了IDictionary<string, object>,但是当您使用dynamic键入它时,您可以访问相关属性,例如常规属性! ;)