iT邦幫忙

2025 iThome 鐵人賽

DAY 27
0
佛心分享-IT 人自學之術

API 實戰入門從設計到驗證系列 第 27

Day27 觀察公開 API 的實際運作

  • 分享至 

  • xImage
  •  

在熟悉Hoppscotch的操作與基本測試流程後,可以進一步觀察公開API的實際運作方式。公開API(Public API)是一種開放給開發者自由使用的網路服務,通常不需要註冊或授權,就能直接發送請求並取得資料。

使用Hoppscotch測試時,可以從最簡單的GET請求開始。舉例來說,只要在Hoppscotch的URL欄位輸入連結、選擇GET方法並按下「Send」,就能看到伺服器的JSON回應。輸入以下網址:

https://catfact.ninja/fact

這是一個提供「貓咪冷知識」的小型API。這是一個API回應格式,每個欄位都有名稱與對應值。
fact是主要內容,length則表示字數。

也有一些公開API提供圖片或數字結果,例如:

當發送API請求後,伺服器會回傳一段資料,也就是「回應(Response)」,理解回應內容,是測試與除錯API的關鍵步驟。通常回應會包含三個部分:

  • 狀態碼(Status Code):例如200表示成功、404表示找不到資源。
  • Header(回應標頭):描述資料型態、伺服器資訊等。
  • Body(主體內容):真正的資料內容,例如圖片連結、氣象數據或匯率資訊。

在測試API時,會發現同一個網址在不同地方打開,畫面看起來不一樣,這是因為「工具顯示方式不同」,而不是資料真的不同。

以Hoppscotch為例,它會自動幫回應內容排版成「漂亮的JSON」,加上顏色和縮排,還會顯示狀態碼、回應時間與資料大小,讓回應結構更清楚,開發者可以一眼看出資料的層次,但如果在瀏覽器直接開啟同一個網址,畫面會變成一整行密密麻麻的文字,看起來很難閱讀,實際上這兩個結果完全一樣,只是呈現方式不同,Hoppscotch會幫忙整理,而瀏覽器只是單純顯示。

觀察不同API的輸出,可以發現雖然資料內容不相同,但大多遵循類似的規則:清楚的欄位名稱、層級分明的JSON結構,以及一致的格式化風格,這些共通點正是「良好API設計」的重要原則。


上一篇
Day26 API 實測中的時間與延遲(Latency)
下一篇
Day28 用程式實際連接 API
系列文
API 實戰入門從設計到驗證29
圖片
  熱門推薦
圖片
{{ item.channelVendor }} | {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言