RESTful API的根資源應該包含哪些內容？

向API請求'/貓'會返回一組貓，同時請求'/ cats/123'返回其編號爲'123'的貓RESTful API的根資源應該包含哪些內容？

我的問題是：'/'應該是什麼？（API的根）被請求？

一個帶有API中所有集合名稱的索引可能是什麼？

2016-02-27 David V

如果您需要開發人員友好的消息，那麼我會建議使用內置或第三方文檔工具，這些工具可生成文檔從外部訪問鎖定。 api根應該返回404，因爲沒有任何東西駐留在那裏，對嗎？ –

這可能沒有客觀答案，但一個很酷的API應該是可瀏覽的。這意味着，給定一個起始URI，應該可以完全「發現」API，因此它肯定有助於獲得鏈接到API所有不同部分的根資源。

即使所有的服務都是獨立的應用程序（想想微服務），我仍然會創建一個服務，讓所有的「開始」鏈接真正有一個入口進入整個應用程序。

我的意思不僅僅是人類瀏覽，而且客戶端也會從第一個URI開始。總是，除了將書籤用於以前的狀態（以及在給定重定向或未找到時需要維護這些書籤）。

2016-02-27 08:30:36

我不知道這是否有一套公約。這取決於你想要提供什麼，以及你的安全問題。您可能會考慮在REST API中返回有效對象的列表。或者，如果您不想向任何人泄露該信息，請考慮返回204或404.

2016-02-27 22:18:13 zerobandwidth

回答