Web API - 要放置/路由什麼？

Question

所以，

我正在開發一個REST API，我只有資源映射到某些輸出使用的路由，我只是不關心根路由（/），但我很好奇人們做什麼。

人們在REST API上放置了哪些內容？

資源列表？所有資源？有沒有什麼「良好的API實踐」可以告訴我關於這方面的一些情況？

???

Answer 1

在由超媒體驅動的真正RESTful API中，根URI通常是入口點，客戶端將事先知道的唯一URI。它應該返回一個帶有其他資源鏈接的文檔。如果你不明白這是什麼意思，請閱讀this。

在街道的REST API，我們在互聯網看到的 - 不使用HATEOAS，並沒有真正的RESTful - 有沒有真正的約定，但我已經看到很多模式：

• 一個「你好世界」。
• 重定向到主頁面。
• 重定向到API文檔。
• 狀態頁面，包含一些服務器信息。
• 實際的超媒體文檔，帶有一些鏈接。
• 用戶配置文件信息