我有一个 REST API,它公开一个 URI 以返回 JSON 中的员工集合。URI 的格式如下:
http://webservice/employees
我现在想公开一个 URI,它返回按他们工作的办公室分组的员工数量以及有关办公室的更多信息。例如:
items: [{
officeId: 1,
officeName: "Big Office",
switchboardTel: "123456789",
numEmployees: 100
},
{
officeId: 2,
officeName: "Small Office",
switchboardTel: "987654321",
numEmployees: 30
},
... // etc.
]
什么是合适的 URI?我在想,鉴于它返回有关办公室的信息(以及员工人数),那么也许应该通过“办公室”资源检索这些信息:
http://webservice/offices
或者,以下 URI 是否更合适?
http://webservice/employees?groupBy=office
在我看来,这似乎有点错误,因为响应返回的是有关办公室的信息,而不是员工的信息,以及员工人数。
假设我想公开一个 URI,它返回按年龄分组的员工人数......这是否属于“员工”资源,例如:
http://webservice/employees?groupBy=age
...或者它是否更适合创建“年龄”资源:
http://webservice/ages
在我看来,“groupBy=age”选项在这里似乎是最好的……但那样会使 URI 格式略有不一致。
基本上,我想要一个一致的 URI 格式来获取按某些标准分组的员工数量 - 并让响应包含有关分组的信息。
在此先感谢您的帮助。
汤姆