API ドキュメントの読み方
あなたは API ドキュメントに住み込むことになるので、全部を読まずに必要なものを素早く手に入れる方法を示す。どのエンドポイントについても、5つのものを狩りに行こう。
- メソッドと URL —
GET /forecast。それが何をするかが、2つのトークンでわかる。 - 認証 — どのヘッダーやキーが必要か。たいていは API 全体で共通のセクションがひとつある。
- パラメータ — 送れる入力（ここでは
city）、どれが必須か、そしてその型。 - レスポンスの例 — 返ってくる JSON の形だ。これは宝物である。コピーすること。
- エラー — 何かおかしいときに何が返ってくるか、そしてステータスコード（
401認証されていない、404見つからない、429レート制限）。
よいドキュメントには、コピペできるリクエストとレスポンスの例が含まれている。この2つのスニペットは、何段落もの散文よりも多くを教えてくれる——それをつかんで、AI に手渡そう。