[ADP-111] GET

概述

HTTP GET 方法基本用於從指定資源請求數據。使用 GET 的請求應該只檢索數據，不應對數據產生任何其他影響。

指導原則

• GET 請求不應(SHOULD NOT)改變資源的狀態。可以重複執行而不會導致不同的結果。
• GET 請求不應(SHOULD NOT)造成使用者需要負責的任何副作用。
• 對 GET 請求的回應應該(SHOULD)可以快取，以提高性能並減少伺服器負載。參見 快取控制。
• 可(MAY)使用查詢參數來過濾、排序或分頁所請求的數據。參見 分頁、排序、過濾。
• 不可(MUST NOT)在 GET 請求附帶請求主體。

使用方法

1. 保持 GET 請求的冪等性。
2. 避免使用 GET 進行修改數據的操作。
3. 使用有意義且符合 RESTful 的 URL 結構。
4. 為 GET 請求實現適當的錯誤處理。
5. 考慮對公開的 GET 端點進行速率限制。

示例 1: 檢索使用者列表

請求:

GET /users

回應:

HTTP/1.1 200 OK

[
    {
        "id": 1,
        "name": "Alice"
    },
    {
        "id": 2,
        "name": "Bob"
    }
]

示例 2: 通過 ID 檢索單個使用者

請求:

GET /users/1 HTTP/1.1

回應:

HTTP/1.1 200 OK

{
    "id": 1,
    "name": "Alice"
}

參考資料

• RFC 9110: GET
• MDN Web 文件: HTTP GET