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

Question

我对 API 设计和 MVC 概念真的很陌生，但据我所知，像 GET/api/products 这样的东西应该返回一个产品列表，而 GET/api/products/1 应该返回一个产品。就速度而言，我的感觉是/api/products 应该返回较少的信息，即仅 id 和名称，而/api/products/1 应该返回更多信息，即 id、名称和描述。

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

• http://www.nuget.org/packages/WebApi.PartialResponse/ - 安装此包导致程序集版本错误。
• 在产品字段上添加 ShouldSerialize 方法。由于我不会在这里深入的原因，这种方法有点麻烦。
• 查看了 ASP.NET Web API partial response Json serialization但那里似乎没有确凿的答案。
• ASP.NET WebApi and Partial Responses建议使用具有所有可为空字段的产品类。我不确定我是否确切了解该做什么。

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

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

Answer 1

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

• fields=items/id,playlistItems/snippet/title,playlistItems/snippet/position
• fields=items(id,snippet/title,snippet/position)
• fields=items(id,snippet(title,position))

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