怎么读 API 文档
你会长期泡在 API 文档里,所以这里教你怎么不读完全部就快速拿到你要的东西。对任何一个端点,去搜寻这五样东西:
- 方法和 URL ——
GET /forecast。它做什么,两个词说清。 - 认证 —— 它需要什么 header 或 key。通常整个 API 共用一个章节。
- 参数 —— 你可以发的输入(这里是
city),哪些是必填的,以及它们的类型。 - 一个示例响应 —— 你会拿回的 JSON 形状。这是宝贝;把它复制下来。
- 错误 —— 出问题时会返回什么,以及状态码(
401未授权、404未找到、429触发速率限制)。
好的文档会包含一个可以直接复制粘贴的示例请求和响应。这两段代码片段,比几段文字告诉你的还要多——把它们抓过来,交给 AI。