什么应该在REST API的主页上找到?

时间:2013-12-22 23:58:37

标签: api rest standards

我目前正在编写REST API,这个问题似乎总是弹出。

我一直只是添加了一个描述,快速链接到文档,服务器时间等,但现在看(稍后看一下),简单的重定向到API文档会更好。

我的问题是,作为API的根目录 - “/” - “主页”的公认标准是什么?

我一直在研究一些实现:

  • Facebook:只是给出了“不支持的获取请求”的错误。
  • Twitter:显示实际的404页面;
  • StackOverflow:重定向到快速“使用”页面。

在看完这些之后,很明显每个人都采用不同的方式。

从更大的角度来看,这意义不大,但看看“RESTfull”这样做的方式(如果有的话)可能很有意思。

1 个答案:

答案 0 :(得分:1)

其他人也有同样的问题,你发现自己每个人都是按照自己的方式行事。在这方面有一个举动,以某种方式标准化它,所以看看你是否觉得这个草案有用:

Home Documents for HTTP APIs又名JSON Home。