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

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

所问的这个问题不清楚。我猜这意味着所有API方法都在一个目录下。例如，Flickr API的根目录是

有关访问Flickr API的项目示例，请参见

一,

二,

---

1.NerdDinner使用WCF数据服务，这是正确实现RESTful服务的好方法。我之所以要指出这一点，而不是直接使用WCF数据服务，是因为它是一个公共网站，您可以使用它。

---

2.MediaWiki不是一个很好的例子，因为它们在URI中传递操作，但从技术上讲，它是一个REST式服务，并展示了许多有趣的想法。

REST API的根端点是为dispatcher servlet之后的url的第一个斜杠定义的API，即“/”。它包含资源列表的所有GET（主要是所有数据库表的GET）。该列表还包含所有项目，在单个项目中，将有DELETE、PUT/PATCH和SELF GET URL。因此，HATEOS的实现。

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

我想应该是404。如果没有与根路径关联的资源，那么就没有要返回的内容

---

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

REST应该是自描述的，所以在我看来，让根显示错误是糟糕的设计。 我喜欢根目录包含允许您浏览API其余部分的信息。 例如，根目录可能包含一个指向产品类别列表的链接，API用户可以从中选择一个类别，然后选择一个产品列表等。

---

自描述API意味着编写和更新的文档更少

我是说在另一边。。。查看从web应用程序调用flickr api时文件的外观…这是一个定义不清的问题！请提供更多详细信息这一直是我的思考过程，但是有很多infra项目试图ping root作为一种保持活动或健康检查。令人恼火的是，这些解决方案中的许多在没有黑客的情况下是无法配置的（例如azure容器应用程序服务）。