RESTful API的根资源应该有什么?

时间:2016-02-27 01:16:54

标签: rest restful-architecture

向API请求'/ cats'会返回一组猫,而请求'/ cats / 123'会返回id为'123'的猫

我的问题是:当'/'(API的根目录)被请求时,响应应该是什么?

带有API中所有集合名称的索引可能是吗?

2 个答案:

答案 0 :(得分:3)

这个可能没有客观的答案,但应该可以浏览一个很酷的API。这意味着,给定一个起始URI,应该可以发现"发现"完整的API,因此它肯定有助于拥有一个链接到API的所有不同部分的根资源。

即使所有服务都是单独的应用程序(想想微服务),我仍然会创建一个服务来启动" start"链接到所有,真正有一个入口点进入整个应用程序。

我的意思不仅仅是让人类浏览,而且客户端也会从第一个URI开始。总是如此,除非在以前的状态下使用书签(并且在给定重定向时需要保留这些书签,或者没有找到)。

答案 1 :(得分:0)

我不知道这是否有一套约定。这取决于您想要提供什么,以及您的安全问题。您可以考虑在REST API中返回有效对象的列表。或者,如果您不想向任何人透露该信息,请考虑返回204或404。