REST设计-获取精简资源的集合

Question

我有一个web服务来检索我的用户列表：/users

我的用户实体有很多属性（有很多关系，如角色、地址等），检索整个列表开始很痛苦。

我想创建一个新的web服务来检索最小用户DTO的列表。此DTO仅包含用户名、名字和姓氏。

你对这个新URI有什么建议？

/users-minimal
/users/minimal
/users/func/get-minimal
... ?

Answer 1

如果改变的只是表示，那么应该将其作为不同的媒体类型而不是不同的URI。例如，如果普通用户有application/vnd.mycompany.user.v1+json，那么最小用户可以使用application/vnd.mycompany.user-minimal.v1+json。

现在，您可能没有使用像上面这样的自定义媒体类型，如果您询问RESTful URI，您可能也没有使用HAEOAS。对于那些类似REST的HTTPAPI，您可能应该使用querystring参数。类似/users?minimal=1或/users/?fields=username,first_name,last_name的东西。