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

时间:2015-06-29 16:38:41

标签: rest

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

/items

返回项目列表。端点返回项目上的所有属性,最终返回 lot 数据,因为每个项目都是一个非常重的JSON对象。

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

是否存在此类端点的命名约定?

我正在思考

/lightweight-items

或类似。

1 个答案:

答案 0 :(得分:3)

  

是否存在此类端点的命名约定?

不是我听说过的。同样/lightweight-items意味着有些资源被称为'轻量级项目',这不是真的。

我建议你添加一个查询选项来指定你需要的数据,比如

/items?properties=name,year

name,year是您想要检索的地方