ASP.NET WebApi - 两种可能的JSON“返回”类型？

Question

一个小前奏

您好，我开发的WebAPI REST服务，目前我正在返回不同的字典端点在JSON（实体的阵列，不Dictionary数据类型混淆）格式。字典可以按名称检索：/dictionaries/:dictName。问题是，物品存放在字典可以有两种类型：

第一类实体

class Item { 
    public long ID { get; set; } 
    public string Name { get; set; } 
} 

第二类实体的 - 扩展项

class ExtendedItem : Item { 
    public string AdditionalProperty { get; set; } // Let's name it this way just for example 
} 

---

问题

我想避免发送不需要它的字典AdditionalProperty。

---

目前的解决方案

我已经开发了一个ApiController简单的方法：

public IHttpActionResult GetDict(string name) 
{ 
    try 
    { 
     object outDict = null; 

     switch(name) { 
      case "simpleDict": 
       IList<Item> simpleDict = _dataLayer.GetSimpleDict(); 
       // ... 
       outDict = simpleDict; 
       break; 
      case "extDict": 
       IList<ExtendedItem> extDict = _dataLayer.GetExtDict(); 
       // ... 
       outDict = extDict; 
       break; 

      // ... and a few more dictionaries 
     } 

     SomeLogger.SomeLogging(name, outDict); 
     return Ok(outDict); 
    } 
    catch (Exception ex) 
    { 
     // Just returning error 
     return BadRequest(ex.Message); 
    } 

} 

---

结论和问题

虽然我设法找到这个问题的解决方案，我并不完全满意。就个人而言，我想找一个简单的方法来避免使用object数据类型，但无法找到任何数据。现在问题来了：

1. 什么是更好的编程实现这种解决方案的方式？对我来说更好表示不使用object类型的解决方案。有没有简单的方法来限制IList包含Item或ExtendedItem，并且没有其他类型？
2. 或者我应该彻底改变这个问题的方法？
3. 或...也许这种方法是正确的，我有点过敏？ ;-)

我将不胜感激任何帮助。

Answer 1

如果您声明变量outDict作为一个集合，而不是object，那么你就可以直接分配。

IEnumerable<Base> outDict = null; 

switch(name) { 
    case "simpleDict": 
     IList<Item> simpleDict = _dataLayer.GetSimpleDict(); 
     // ... 
     outDict = simpleDict; 
     break; 
    case "extDict": 
     IList<ExtendedItem> extDict = _dataLayer.GetExtDict(); 
     // ... 
     outDict = extDict; 
     break; 

    // ... and a few more dictionaries 
} 

Answer 2

尝试使用Interface释放ExtendedItem的实现。使用Object for API返回可能非常有用，如果您需要在返回回调响应之前输入dynamic以处理不同的事情。

interface Item { 
    public long ID { get; set; } 
    public string Name { get; set; } 
} 

class SimpleItem : Item { 
    public long ID { get; set; } 
    public string Name { get; set; } 
} 

class ComplicateItem: Item { 
    public long ID { get; set; } 
    public string Name { get; set; } 
    public string AdditionalProperty { get; set; } 
} 

在API控制器

然后，

Item outDict; 

    switch(name) { 
     case "simpleDict": 
      var simpleDict = _dataLayer.GetSimpleDict(); 
      // ... 
      outDict = simpleDict; 
      break; 
     case "extDict": 
      var extDict = _dataLayer.GetExtDict(); 
      // ... 
      outDict = extDict; 
      break; 

     // ... and a few more dictionaries 
    } 

Answer 3

你可以只返回switch语句，以及：

public IHttpActionResult GetDict(string name) 
{ 
    try 
    { 
     switch(name) { 
      case "simpleDict": 
       return Ok(_dataLayer.GetSimpleDict()); 
      case "extDict": 
       return Ok(_dataLayer.GetExtDict()); 
     } 

     SomeLogger.SomeLogging(name, outDict); 
     return Ok(new List<Item>()); 
    } 
    catch (Exception ex) 
    { 
     // Just returning error 
     return BadRequest(ex.Message); 
    } 
}