まとめと実践
重要なポイント
- は、あるプログラムが別のプログラムに差し出すリクエストのメニューであり、契約です:合意した方法で尋ねれば、合意した形の答えが返ります。ほとんどの API バグは、どちらかがその契約を破ることです。
- は答えが返ってくる形式です — キーと値からなり、オブジェクト
{ }と配列[ ]で組み立てられ、入れ子になります。データ型は string・number・boolean・null・array・object です。 - 文字列 vs 数値の罠(
42と"42")と、欠落 vsnullが最もよくある形のバグです。もう JSON は読めるのですから — 何かおかしな挙動をしたら型を確認しましょう。 - API キーはパスワードです。決してブラウザに送らず、決して にコミットせず、環境変数に保存しましょう。漏れたキーは直ちにローテート(rotate)すべきです。
- レート制限(
429)と 従量課金に注意しましょう — 有料 API を休みなく呼ぶ AI 製のループが、四桁の請求書を生む道です。まず料金を読み、予算アラートを設定しましょう。
やってみよう
ブラウザでキー不要の無料 API を探してみましょう — たとえば新しいタブで https://api.github.com/users/octocat を直接開きます。生の JSON レスポンスが見えます。フォームのように読みましょう:オブジェクト { } を拾い出し、配列があれば見つけ、異なる値を三つ選んでその型に名前をつけます(どれが文字列?数値?真偽値? null のものはある?)。この章が、AI がつなぐすべての API レスポンスに対してやってほしいと言っている、まさにその点検をいま行ったことになります。
この章のプロンプト
私はAPIを呼び出していて、初心者として自分でデータの形を確認したい。
これが本物のドキュメントです (例のリクエスト + 例のレスポンス):
<APIドキュメントの例のリクエストとJSONレスポンスをここに貼り付けてください>
- パース用コードを書く前に、この呼び出しが返す生のJSONを見せて、
キー、その型、そしてnullや欠けている可能性のあるものを指摘して。
- 私のコードが読むキーが、そのレスポンスに実際に存在するか確認して。
- APIキーがサーバー上の環境変数から読み込まれ、
ハードコードされたりブラウザに送られたりしないようにして。
- 呼び出しが失敗したり、タイムアウトしたり、レート制限に達したらどうなるか教えて。