iT邦幫忙

2024 iThome 鐵人賽

DAY 3
0

API請求的基本結構
發送 API 請求是與伺服器交換數據的主要方式。
基本上由四個部分組成:

  1. URL(統一資源定位符): 指定伺服器上的資源位置。

  2. 方法(Method): 指定你想對資源執行的操作,常見的方法有 GET、POST、PUT 和 DELETE。

  3. Header(標頭): 如 Content-Type 表示數據格式(JSON 或 XML),Authorization 進行身份驗證。

  4. Body(請求主體): 包含要發送給伺服器的數據,主要在 POST、PUT 這些方法中使用。

GET、POST、PUT、DELETE 方法介紹

先稍微講一下經常被用在API的請求和回應中的格式(特別是與 RESTful API 交互時)——JSON(JavaScript Object Notation),它是一種輕量級的數據交換格式,使用人類可讀的文本來傳遞數據對象(之後的章節會提到它的一些基礎語法)

  • GET
    當你發送一個 GET 請求時,Sever通常會以 JSON 格式回應:
    https://ithelp.ithome.com.tw/upload/images/20240916/20153147rzsPuF25YS.png

  • POST
    當你發送一個 POST 請求時,請求body中的數據通常會以 JSON 格式傳遞:
    https://ithelp.ithome.com.tw/upload/images/20240916/20153147a2GwW4i1WS.png
    Sever會接收這些 JSON 數據並進行處理,例如創建一個新用戶。

  • PUT:
    用來更新資源的數據,並且通常要求完整的資源數據。當發送 PUT 請求時,我們會將更新的數據作為 JSON 請求body發送給Sever。
    https://ithelp.ithome.com.tw/upload/images/20240916/20153147I4sE42OHEE.png

  1. URL: /users/1 表示更新 ID 為 1 的用戶。
  2. 請求頭(Header): Content-Type: application/json 表示我們傳遞的數據格式為 JSON。
  3. 請求主體(Body): 包含更新後的用戶資訊,這裡更新了用戶的 name、email 和 age。

當sever收到這個請求時,會更新指定用戶的數據,通常返回一個表示操作成功的 JSON 回應。

  • DELETE:
    使用 DELETE 刪除用戶
    https://ithelp.ithome.com.tw/upload/images/20240916/20153147iGZdIS5uCo.png
  1. URL: /users/1 表示刪除 ID 為 1 的用戶。
  2. 請求頭(Header): DELETE 通常不需要請求主體或數據,但仍可以包含例如身份驗證的頭信息。

在這個例子中,當伺服器接收到 DELETE 請求後,會刪除指定的資源(用戶 ID 為 1),並返回成功或失敗的回應。

有時刪除請求可能需要額外的數據,比如確認某種條件或指定其他參數。可以用 JSON 作為請求主體傳遞:
https://ithelp.ithome.com.tw/upload/images/20240916/20153147KAk9cM521B.png
這個例子表示根據 email 刪除用戶。

今天先這樣,明天會介紹JSON 與 XML格式的一些基礎與法及優勢!


上一篇
DAY2.為什麼 API 這麼重要?
下一篇
DAY4. API 的資料格式:JSON 與 XML
系列文
API 101:從基礎認識到應用的全方位指南-Swagger/Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言