rest - 唯一资源的 REST 资源命名

Question

我有一个资源，它基本上是当前（经过身份验证的）用户可以访问的所有东西的聚合。让我们称之为Workspace。

鉴于Workspace每个用户始终只有一个：

我应该应用“复数”约定吗？如果是，我应该创建一个虚假的子资源来表示它是唯一的吗？

换句话说，我应该使用：

• /workspace-> 当前用户工作区

或者

• /workspaces/~-> 当前用户工作区
• /workspaces-> 404

/workspace从用户的角度来看，拥有一个独特的资源是有意义的。但是从系统的角度来看，有许多工作区，但每个用户只有一个，因此/workspaces/~看起来更合乎逻辑。

标签： restnaming-conventions

Answer 1

这里没有任何硬性规定。我会说使用对您的最终用户有意义的任何东西，并且最好与您在其他地方所做的一致。

例如，根据您的网站的工作方式，您会想到其他一些地址。/users/{id}/workspaces如果工作空间与用户相关联，那么将其放在地址下可能是有意义的。也许这对你的情况没有意义。因此，在您提供的选项中，我会说如果客户很明显应该有多个工作区但他们只能访问一个，那么/workspaces/{id}地址将适合该模型。如果他们认为工作空间是一个独特的实体，那么使用复数地址可能会造成混淆。

在我自己的设计中，我倾向于错误地使用复数来表示所有内容。