RESTful API

Date
Jun 6, 2023
Property
Medium
Created by
Status
Done
Tags
RESTful
一個標準的RESTful API請求由以下部分組
  1. HTTP方法(HTTP Method):標識客戶端希望對資源執行的操作類型。常見的HTTP方法包括:
      • GET:用於獲取資源的表示。
      • POST:用於在伺服器上創建新的資源。
      • PUT:用於更新現有資源。
      • DELETE:用於刪除資源。
  1. 資源路徑(Resource Path):表示要操作的資源的路徑。這通常是URL的一部分,並且可以包含路由參數或查詢字串。
    1. 例如:
      • /users:表示操作用戶資源的集合。
      • /users/{userId}:表示操作特定用戶的資源。
  1. 標頭(Headers):包含了請求的元資訊和控制參數,例如Content-Type、Accept、Authorization等。
  1. 查詢字串(Query String):可選的,用於在URL中附加參數,以進一步指定請求的細節或過濾資源。查詢字串以"?"開始,並且包含一個或多個鍵值對。
    1. 例如:
      • /users?role=admin:表示檢索具有"admin"角色的用戶。
  1. 請求主體(Request Body):在某些請求中(如POST、PUT等),客戶端可以通過請求主體傳遞資料給伺服器。通常使用JSON或其他格式來表示資料。
總結而言,一個標準的RESTful API請求由HTTP方法、資源路徑、標頭、查詢字串和請求主體等組成,這些組成部分共同描述了客戶端對資源的操作和相關細節。