rest - 自然键和 RESTful URL

Question

我有一个正在设计的 RESTful API，它对其所有资源使用数字主键。然而，一种类型的资源有一个方便的自然键，我希望能够将其用作指定单个资源的可选方式。为了一致性起见，所有资源都可以通过它们的主键访问。

就目前而言，我可以这样做(假设 23 是主键):

mysite.com/api/v0/sites/23/

但是，我想知道是否有 惯用语 为资源指定备用自然键的方法。

到目前为止，我正在考虑做这样的事情:

mysite.com/api/v0/sites/?domain-name=someothersite.com/

因此，单个站点资源可以通过其主键和自然键(其域名)访问。我主要关心的是以惯用的方式来做这件事，因为我想让 API 尽可能简单易用。

Answer 1

在您的特定情况下，主键(整数)总是可以很容易地与域名(包括句点的字符串)区分开来。在 URL 的同一位置允许两者似乎完全有效(并且直观):

mysite.com/api/v0/sites/23
mysite.com/api/v0/sites/someothersite.com

记录它也很简单，因为每个都是站点的唯一标识符:

mysite.com/api/v0/sites/{id}
  id: primary key or fully-qualified domain name