如何使用ASP.Net Web Api 2进行部分响应

我是API设计和MVC概念的新手,但据我所知,像GET / api / products这样的东西应该返回一个产品列表,而GET / api / products / 1应该返回一个产品。 在速度方面,我的感觉是/ api / products应该返回较少的信息,即id和name,而/ api / products / 1应该返回更多,即id,name和description。

据我所知,处理此问题的最佳方法是不在/ api / products端点中返回产品类的某些字段。 对于/ api / products?fields = name,这尤其必要。 我正在使用ASP.Net Web Api 2并尝试了以下方法:

  • http://www.nuget.org/packages/WebApi.PartialResponse/ – 安装此软件包导致程序集版本错误。
  • 在Product字段上添加ShouldSerialize方法。 由于我不会进入这里的原因,这种方法有点麻烦。
  • 看看ASP.NET Web API部分响应Json序列化,但似乎没有一个确定的答案。
  • ASP.NET WebApi和Partial Responses建议使用包含所有可空字段的产品类。 我不确定我到底知道该做什么。

有什么简单的方法可以做我想做的事情吗?

否则你能建议一个比我正在做的更好的API设计吗?

您也可以使用WebApi.PartialResponse( http://www.nuget.org/packages/WebApi.PartialResponse/ )。 这是我写的一个包,它使用LINQ to JSON(Json.NET)来操作返回的对象。 它使用Google在其API中使用的字段语法,例如:

  • 字段=项/ ID,playlistItems /片断/标题,playlistItems /片断/位置
  • 字段=项(ID,段/标题,片段/位置)
  • 字段=项(ID,片段(标题,位置))

您可以在GitHub项目页面上找到更多信息: https : //github.com/dotarj/PartialResponse 。

我建议在返回实体列表时使用单独的类进行映射。

特别是因为问题不仅仅是您返回给用户的内容,还包括您从数据库中选择的内容。

因此,使get和entity返回一个Product对象,获取实体列表会返回一个ProductLink对象或类似的对象。

编辑

根据jtlowe的评论,如果你有许多不同的方法返回产品属性的微小变化,使用匿名类(虽然我怀疑这是否一定是一个好的设计)。

在你的行动中考虑这样的事情

return from p in this.context.Products select new { p.Id, p.Name, p.SKU }; 

这个:

  • 仅从数据库中选择所需的列。
  • 不需要为产品的新变体定义其他类

这并不容易将此语句的结果传递给其他方法,因为您只能将其作为IEnumerable,object或dynamic返回。 如果你把它放在控制器中那么它可能就足够了。 如果要实现存储库模式,则在使用匿名类型时,将无法返回强类型列表。