RESTful GET集合API应该返回元素的内容吗?

Question

我有一个实体存储在后端，翻译成json格式为，

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

所以当我想使用api

检索元素列表时

GET /elements

我应该只返回元素元数据(id，名称，描述)还是应该还包括内容(models[])?

Answer 1

正常

GET /elements

将返回一个完整实体的列表。

您可以添加另一个端点:

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

返回一个只包含元数据的List。