正在準備工作環境...
看懂 API 文件
你在 json-api-101 學過 API 的基本概念。但實際工作中，你拿到的不是教學範例，而是一份「API 文件」——長得像規格書，充滿了 endpoint、parameter、response 這些詞。
這一課教你怎麼讀懂它。
API 文件的三大元素
一份 API 文件最重要的三件事：
- Endpoint（端點）：你要打哪個網址
- Parameters（參數）：你可以帶什麼條件
- Response（回應）：API 會回傳什麼
實際範例：商品搜尋 API
假設你在看一份電商平台的 API 文件：
Query String 怎麼組
URL 裡 ? 後面的部分叫 Query String，多個參數用 & 連接：
必填 vs 選填參數
API 文件會標示哪些參數是必填（required）、哪些是選填（optional）：
HTTP 方法速查
| 方法 | 用途 | 電商範例 |
|---|---|---|
| GET | 取得資料 | 查商品、看訂單 |
| POST | 建立資料 | 下單、加入購物車 |
| PUT | 整筆更新 | 修改商品全部資訊 |
| PATCH | 部分更新 | 只改價格或庫存 |
| DELETE | 刪除資料 | 取消訂單 |
AI 協作：學了這個，跟 AI 怎麼配合？
看懂 API 文件，你就能精確地告訴 AI「要串哪個端點、帶什麼參數」，而不是模糊地說「幫我拿資料」。
你的人類優勢：
- 你知道業務需要哪些資料欄位，能挑出正確的端點
- 你能判斷參數值是否合理（分類名稱、日期範圍、筆數限制）
可以這樣跟 AI 說：
這是我們平台的 API 文件（貼上文件截圖或文字）。我要查詢 2024 年 3 月所有「已完成」的訂單，幫我組出正確的 API 請求 URL。
練習題
互動示範
DEMO 1可以修改程式碼試玩
DEMO 2可以修改程式碼試玩
DEMO 3可以修改程式碼試玩
DEMO 4可以修改程式碼試玩
挑戰任務
Task 1
用 URLSearchParams 組出查詢 URL。基礎網址是 https://api.shop.com/products，參數：keyword=帽子、sort=price_asc、limit=5。印出完整 URL。
Task 2
將路徑參數嵌入 URL。訂單編號是 ORD-2024-888，端點格式是 /api/orders/{orderId}，基礎網址 https://api.shop.com。印出完整 URL。
Task 3
根據 HTTP 方法對應正確操作。印出以下格式（每行一個）： GET → 查詢 POST → 建立 PUT → 更新 DELETE → 刪除
Next Lesson →