返回隐藏大多数属性的实体列表的RESTful资源的命名约定?

返回隐藏大多数属性的实体列表的RESTful资源的命名约定?,rest,Rest,我们有一个端点,我们称之为端点 /items 它返回一个项目列表。端点返回项目的所有属性,并最终返回大量数据,因为每个项目都是一个相当重的JSON对象 目前,我正在考虑为这个端点创建一个轻量级变量,它可以用来减少带宽,并且只返回有限数量的属性(例如,仅返回item.Name和item.Year) 这样的端点是否有命名约定 我当时在想 /lightweight-items 或类似的 这样的端点是否有命名约定 我没听说过。另外,/lightweight items意味着存在称为“lightwei

我们有一个端点,我们称之为端点

/items
它返回一个项目列表。端点返回项目的所有属性,并最终返回大量数据,因为每个项目都是一个相当重的JSON对象

目前,我正在考虑为这个端点创建一个轻量级变量,它可以用来减少带宽,并且只返回有限数量的属性(例如,仅返回item.Name和item.Year)

这样的端点是否有命名约定

我当时在想

/lightweight-items
或类似的

这样的端点是否有命名约定

我没听说过。另外,
/lightweight items
意味着存在称为“lightweight item”的资源,这是不正确的

我建议您添加一个查询选项来指定所需的数据,例如

/items?properties=name,year

其中,
name,year
是您想要检索的内容

如果您认为有人会读取URI,那么拼写属性可能会更好。