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

Question

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

Answer 1

这个问题非常清楚。

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

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

Answer 2

这个问题尚不清楚。我猜它意味着像所有API方法所在的目录。例如，Flickr API的根目录为http://api.flickr.com/services/rest/。

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

Answer 3

• NerdDinner.com ¹
• The Sun Cloud API
• Twitter
• Paul Jame's article
• MediaWiki's API ²

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

Answer 4

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

Answer 5

REST应该是自我描述的，因此在我看来，根显示错误是设计不佳。 我喜欢root包含允许您导航其余API的信息。 因此，例如，根可能包含指向产品类别列表的链接，API用户可以从中选择类别，然后选择产品列表等。 自描述API意味着更少的文档可以编写并保持更新!!

Answer 6

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

在节点 JS 中，使用 res.redirect("https://<<your frontend>>");