Rest API 架构 - 通过别名获取资源

Question

我需要关于 REST Arch 的帮助。 我有一个资源，我可以使用经典的 GET /resource/ID URI 来检索它，但是这个资源有一个别名，有人想通过别名调用它来获取这个资源。

有一个很好的方法是调用 GET /resource/?alias=x，获取 ID，然后转到详细信息 /resource/ID。

您对其他方法有什么好的想法吗？

提前致谢

Answer 1

如果您想保持在 REST 架构的约束范围内，您肯定需要使用动词 GET。不能添加其他方法。

现在您需要确定资源的命名方式。您有一个规范名称（您的 id）和一个别名。一种方法是为

设置控制器

GET /things/:id

这样:id 可以是或者 规范ID 或 别名。所以你会有

app.get('/resources/id', function (req, res) {
  var id = req.params.id;
  if (isAlias(id)) id = resolveAlias(id);
  Thing.findById(id, null, function (err, thing) {
    if (err) res.json(400, err)
    if (thing === null) res.json(404, {"No such id": id})
    res.json(thing)
  });
});

您也可以按照您的建议将别名作为查询参数输入。

我怀疑唯一的其他方法可能是使用不同的网址（things 以外的其他网址），但我认为这是不诚实的，因为无论您是否使用 id 或别名，您都希望返回相同的表示。应该是同一个控制器，而且你应该使用GET，所以我相信你需要使用路径参数或查询参数。

顺便说一下，这个选择与查询重写无关。

Answer 2

资源有两个 URI（或者两个 URI 指向同一个资源，换句话说）并没有错。例如

GET www.myweatherapi.com/2013/11/18/rainfall

GET www.myweatherapi.com/today/rainfall

可以同时指向同一个资源。您可以说后者是前者的别名，反之亦然，这并不重要，它们都标识相同的资源。您无需开始明确地将某事物标记为其他事物的别名。

如果别名是临时的并且将来可能会消失，您可以使用 307 响应，临时重定向。这告诉客户端他们应该转到不同的 URI 来查找资源，但不要假设将来会是这样（例如限制缓存的时间）。

顺便说一句，客户端不应构造 URI，服务器应返回内容类型格式（HTML、JSON 等），其中包含识别客户端所需资源的方法以及查找位置的 URI他们。例如，带有指向该资源的 URI 的 HTML 链接显示“Todays Rainfall”。如果用户想要今天的降雨量，请点击该链接