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

Question

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

Answer 1

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

我认为它应该用404响应.如果没有与根路径相关的资源,那么没有什么可以返回.

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

Answer 2

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

Answer 3

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

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