在 REST API 资源名称中使用通配符 (*)

Question

在 REST API 中使用 * 作为资源 ID 是否明智？我想用它来搜索。我正在使用 RESTEasy 开发我的网络服务。

假设我有资源是用户并且用户有姓名和年龄。然后我的 REST API 看起来像：

/users/{id}/name
/users/{id}/age

现在，如果我想显示所有名称，我正在考虑使用以下内容：

/users/*/name

这是正确的还是我应该使用其他方式？

编辑 1：添加子资源

从答案中建议使用字段查询参数。但是让我们假设我现在想要一些子资源的属性。例如：

/user/*/name/full
/user/*/name/short

如果我遵循字段选项，我将不得不这样做：

/user?fields=name-short 
/user?fields=name-full 

这不是很好，因为 name 的属性以某种方式链接到 name 类。

请考虑这个例子。试着理解这个想法；）

Answer 1

查询参数

您可能可以使用通配符，但不能以您在问题中显示的方式使用。如果您想在同一请求中获取除名称之外的更多详细信息怎么办？

您可以使用 查询参数 来允许为 users 集合选择字段：

/users?fields=name

/users?fields=age

/users?fields=name,age

或者你可以从partial responses are handled in the Google Drive API的方式中获得一些灵感：

/users?fields=name(short,full)

或者，您可以使用点表示法：

/users?fields=name.short,name.full

或者混合使用两者，比如Spotify API。

自定义媒体类型

如果不需要字段选择，可以使用自定义媒体类型，returning a predefined set of fields。