REST API 根页面的最佳实践是什么？

Question

我想知道是否有一些关于 REST Web 服务的根端点的最佳实践？我的意思是，它应该是一个关于 API 本身使用的简短文档吗？它应该是一个描述所有可用方法的 XML 文档吗？它应该只返回“未知方法”吗？

Answer 1

这个问题对我来说非常清楚。

我认为它应该响应 404。如果没有与根路径关联的资源，则没有任何可返回。

如果你觉得404没有帮助，那么返回文档的URL也可以。

Answer 2

REST 应该是自我描述的，所以在我看来，让根显示错误是糟糕的设计。 我喜欢根目录包含允许您导航 API 其余部分的信息。 例如，根可能包含一个指向产品类别列表的链接，API 用户可以从中选择一个类别，然后选择一个产品列表等。 自描述 API 意味着需要编写和更新的文档更少！！

Answer 3

• NerdDinner.com¹
• Sun Cloud API
• 推特
• 保罗·詹姆斯的文章
• MediaWiki 的 API²

---

1. NerdDinner 使用 WCF 数据服务，这是正确实现 RESTful 服务的好方法。我之所以指出这一点，而不是直接指出 WCF 数据服务，是因为它是一个公共网站，您可以使用它。 2. MediaWiki 不是一个很好的例子，因为它们在 URI 中传递操作，但它在技术上是一个 RESTful 服务，并且展示了很多有趣的想法。

Answer 4

这个问题问得不清楚。我猜这意味着所有 API 方法都位于下面的目录之类的东西。例如，Flickr API 的根目录为 http://api.flickr.com/services/rest/.

有关访问 Flickr API 的项目示例，请参阅 python-flickrapi

Answer 5

REST API 的根端点是为第一个斜杠定义的 API，即调度程序 servlet 之后的 url 的“/”。它包含资源列表的所有 GET（主要是所有数据库表的获取），该列表进一步包含所有项目，并且在单个项目中将有 DELETE 、 PUT/PATCH 和 SELF 获取 URL。从而实现HATEOS。

Answer 6

对我来说，我只是重定向到我的前端。

在 Node JS 中，使用

res.redirect("https://<<your frontend>>");