Web API - 要放置/路由什么?

问题描述:

所以,Web API - 要放置/路由什么?

我正在开发一个REST API,我只有资源映射到某些输出使用的路由,我只是不关心根路由(/),但我很好奇人们做什么。

人们在REST API上放置了哪些内容?

资源列表?所有资源?有没有什么“良好的API实践”可以告诉我关于这方面的一些情况?

???

在由超媒体驱动的真正RESTful API中,根URI通常是入口点,客户端将事先知道的唯一URI。它应该返回一个带有其他资源链接的文档。如果你不明白这是什么意思,请阅读this

在街道的REST API,我们在互联网看到的 - 不使用HATEOAS,并没有真正的RESTful - 有没有真正的约定,但我已经看到很多模式:

  • 一个“你好世界”。
  • 重定向到主页面。
  • 重定向到API文档。
  • 状态页面,包含一些服务器信息。
  • 实际的超媒体文档,带有一些链接。
  • 用户配置文件信息
+0

太棒了!因此,如果我构建了一个由HATEOAS驱动的真正RESTful API,那么我应该把我的“/”路线链接放到集合中?像所有的收藏和他们各自的网站JSON? – gbrennon 2015-04-03 17:51:53

+0

是的。如果您正在构建由HATEOAS驱动的REST API,则根路由可能是客户端将知道的唯一URI,因此它需要链接到他们将使用的所有内容。 – 2015-04-03 18:20:30