应该 RESTful GET 集合 API return 元素的内容

Question

我在后端存储了一个实体，它转换为 json 格式，

{
  "id": 123,
  "name": "test",
  "key": "test1",
  "description": "",
  "models": [
    {
      content
    },
    {
      content
    }
  ]
}

所以当我想使用 api

检索元素列表时

GET /elements

我应该 return 元素元数据（id、名称、描述）还是应该包括内容（模型[]）？

Answer 1

正常

GET /elements

会 return 完整实体列表。

您可以添加另一个端点：

GET /elements/meta 或 GET /elements?mode=meta

这将 return 仅是元数据列表。

Should a RESTful GET collection API return content of elements