Webapi GET 应该返回 id 或值答案

【问题标题】：Webapi GET should return ids or valuesWebapi GET 应该返回 id 或值
【发布时间】：2017-05-06 21:59:43
【问题描述】：

最近我开始为我们的应用程序设计 web api。我在this book 中找到了许多好的提示，但我找不到有关响应内容的问题的答案。假设我有以下模型

class Foo
{
   public int Id {get;set;}
   public string Name {get;set;}
   public int BarId {get;set;}
}

class Bar
{
   public int Id {get;set;}
   public string Name {get;set;}
}

当用户请求获取 Foo 时，WebApi 是否应该从 Bar 模型返回 BarId 或 Name BarId？

所以结果应该是

{
  "id":1,
  "name":"foo",
  "barId":100
}

或

{
  "id":1,
  "name":"foo",
  "barName":"bar"
}

它是否应该同时返回 id 和 value？任何建议将不胜感激。

【问题讨论】：

这个问题主要是基于意见的。许多好的问题会根据专家的经验产生一定程度的意见，但这个问题的答案往往几乎完全基于意见，而不是事实、参考资料或特定专业知识。
一般做法是只发送 Foo ，除非你有一个 UI 布局了所有信息。否则，尽可能少地保留信息将增加您的网络吞吐量以及 UI 响应。如果用户在需要其余信息的地方执行某些操作，则可以通过 Ajax 调用获取。

标签： c# rest asp.net-web-api

【解决方案1】：

这取决于用户界面，他们需要显示什么。

最好同时发送 barId 和 barname，以便所有信息都在该 api 中发送

{
  "id":1,
  "name":"foo",
  "barId":2,
  "barName":"bar"
}

【讨论】：