rest - 从 REST /entries 端点返回完整条目还是仅返回每个条目的 id 和标题？

Question

我有以下 REST API：

• 获取/注释
• 获取 /notes/:id

note 
{
   id, title, body 
}

{id, title}仅从/notes端点返回是否可以接受？当用户请求笔记列表时，我不想拖动笔记正文。当用户使用端点{id, title, body}做出选择并请求具体注释时，我宁愿返回完整注释。/notes/id

/note_list可能应该为此任务引入端点？

标签： rest

Answer 1

我假设使用/notes端点时返回完整资源是 RESTful 的，但对我来说似乎很奇怪。为什么有人需要整个表数据？在 99% 的情况下，您在请求条目列表时只需要参考数据（id 和 name）。

无论如何，经过一些研究，我发现了以下选项：

1. google api风格的部分响应
2. 向端点引入一个特殊参数以/notes标记响应将是部分的，例如/notes/header

方法 1 可能对我的专业 api 来说有点过头了，我可能会选择方法 2。