怎麼讀 API 文件
你會長期泡在 文件裡,所以這裡教你怎麼不讀完全部就快速拿到你要的東西。對任何一個端點,去搜尋這五樣東西:
- 方法和 ——
GET /forecast。它做什麼,兩個詞說清。 - 認證 —— 它需要什麼 header 或 key。通常整個 API 共用一個章節。
- 引數 —— 你可以發的輸入(這裡是
city),哪些是必填的,以及它們的型別。 - 一個示例響應 —— 你會拿回的 形狀。這是寶貝;把它複製下來。
- 錯誤 —— 出問題時會返回什麼,以及狀態碼(
401未授權、404未找到、429觸發速率限制)。
好的文件會包含一個可以直接複製貼上的示例請求和響應。這兩段程式碼片段,比幾段文字告訴你的還要多——把它們抓過來,交給 AI。