Skip to content
ADP
API Design PrincipleBETA

[ADP-303] 乾淨清晰的 URL 路徑

指導原則

  • 應該(SHOULD)使用較短的 URI,而不是具有大層次結構的 URI。
  • 應該(SHOULD)將資源嵌套的深度限制在最多 3 層。
  • 應該(SHOULD)為資源集合使用複數名詞。
  • 應該(SHOULD)對多詞資源名稱使用 kebab-case。
  • 應該(SHOULD)使用查詢參數進行過濾、排序和分頁,而不是深度嵌套。

範例

正確

http
GET /users/{userId}/albums HTTP/1.1

錯誤

http
GET /organizations/{organizationId}/groups/{groupId}/users/{userId}/albums