ああ、ハニーポットは空っぽだ！「くまのプーさん」に学ぶ、API設計とエラー処理の重要性

空腹のプー。ハニーポットは空っぽ、それは404エラーと同じだ！新しいハチミツAPI、つまりハチミツの木を求め、二人は森へ！蜂の襲撃、風船の破裂、ラビットの拒否…次々と襲いかかる困難！果たして、プーは空腹を満たせるのか？それとも、絶望の404エラーに飲み込まれるのか？驚愕のクライマックスが、今、始まる！

Back to blog

空っぽのハニーポットと404エラー

プーは、お腹を空かせたクマのぬいぐるみとして、いつものようにハニーポットに手を伸ばしました。しかし、ポットの中は空っぽでした。がっかりしたプーは、肩を落としてため息をつきました。

「クリストファー・ロビン！」プーは悲しそうに呼びかけました。「ハニーポットが空っぽなんだ。まるで、お気に入りのハチミツの木が消えてしまったみたいだよ。」

クリストファー・ロビンは、プーのハニーポットを覗き込みました。「本当だ、プー。これは大変だ。まるで、君のリクエストしたAPIエンドポイントが、データ（ハチミツ）を提供できない404エラーみたいだね。」

プーは首をかしげました。「404エラー？それは何だい？」

「インターネットの世界では、ウェブサイトやアプリが情報をやり取りするためにAPIというものを使うんだ。ハチミツの木をAPI、ハチミツをデータだと考えてみよう。君がハチミツ（データ）を取りに行こうとしたのに、木（API）が見つからない、それが404エラーだよ。」


function get_Poohs_Honey(honeyPotId) {
  if (honeyPotId == "emptyPot") {
    return {
      status: 404,
      message: "Oh bother! No honey found.  Just like an empty pot."
    };
  } else if (honeyPotId == "fullPot") {
    return {
      status: 200,
      honey: "Yummy golden honey!"
    };
  }
}

let honey = get_Poohs_Honey("emptyPot");
console.log(honey.message); // "Oh bother! No honey found.  Just like an empty pot."

「このコードを見てごらん。`get_Poohs_Honey`という関数は、ハニーポットの中身をチェックするAPIみたいなものだよ。今、ハニーポットは空っぽだから、`emptyPot`を渡すと、404エラーと『ハチミツが見つかりません』というメッセージが返ってくるんだ。」

プーは、少し理解したような気がしました。「じゃあ、ハチミツを手に入れるにはどうしたらいいんだい？」

クリストファー・ロビンは笑顔で言いました。「新しいハチミツのAPIエンドポイントを開発する必要があるね。つまり、新しいハチミツの木を探しに行こう！」

プーは喜びました。「新しいハチミツの木！それは素晴らしい！行こう、クリストファー・ロビン！」

二人は、新しいハチミツの木、つまり新しいAPIエンドポイントを求めて、森の奥へと進んでいきました。

ハチミツAPIへの様々なリクエスト

プーとクリストファー・ロビンは、新しいハチミツの木、つまり新しいAPIエンドポイントを探して森の奥へと進んでいきました。しかし、なかなか良い木は見つかりません。

「お腹が空いたなぁ…」プーはため息をつきました。「いいハチミツの木が見つからないよ。」

「プー、焦らないで。良いAPIエンドポイントを見つけるには、色々な方法を試してみる必要があるんだよ。」クリストファー・ロビンは言いました。

そこでプーは、まず大きな樫の木を見つけ、登り始めました。「蜂の巣から直接ハチミツを取れば良いんだ！」プーは叫びました。これはまるで、データベースに直接アクセスしようとするようなものです。


function getHoneyDirectlyFromBeesNest(treeId) {
  try {
    // 直接データベースにアクセス（危険！）
    let honey = accessDatabaseDirectly(treeId);
    return { status: 200, honey: honey };
  } catch (error) {
    return { status: 500, message: "Ouch! Bees stung me!  Database access error!" };
  }
}

let honey = getHoneyDirectlyFromBeesNest("bigOakTree");
console.log(honey.message); // "Ouch! Bees stung me!  Database access error!"

しかし、怒った蜂の大群に襲われ、プーは木から落ちてしまいました。「痛い！蜂に刺されちゃった！」

次にプーは、クリストファー・ロビンに赤い風船を借りて、蜂の巣に近づこうとしました。これは、非効率な方法でデータを取得しようとするようなものです。

「風船なら蜂に刺されないよ！」プーは嬉しそうに言いましたが、風船は途中で枝に引っかかって割れてしまいました。「ああ、 bother！風船が割れちゃった！」

最後にプーは、ラビットの家を訪ねました。「ラビット、ハチミツを分けてくれないかい？」これは、他のAPIに依存しようとするようなものです。


function askRabbitForHoney() {
  let rabbitsResponse = callRabbitsApi("giveMeHoney");
  if (rabbitsResponse.status == 200) {
    return { status: 200, honey: rabbitsResponse.honey };
  } else {
    return { status: 403, message: "Rabbit says no!  He needs it for his carrot garden." };
  }
}

let honey = askRabbitForHoney();
console.log(honey.message); // "Rabbit says no!  He needs it for his carrot garden."

しかし、ラビットは「ごめんね、プー。ハチミツはニンジンの畑に使うから分けてあげられないんだ。」と断りました。

がっかりしたプーがクリストファー・ロビンの元に戻ると、クリストファー・ロビンは小さなハチミツの壺をプーに渡しました。「プー、少しだけ残ってたんだ。よかったね。」

プーは小さな壺のハチミツを一口舐めて、とても喜びました。「ありがとう、クリストファー・ロビン！少しのハチミツでも、とても美味しいよ！」

クリストファー・ロビンのレスポンスと最適化

プーはしょんぼりしていました。データベースに直接アクセスしようとして蜂に刺され、風船は割れ、ラビットにはハチミツを分けてもらえませんでした。色々なAPIエンドポイントを試したけれど、どれも上手くいきませんでした。

「クリストファー・ロビン…どうしたらハチミツが手に入るんだい？」プーは涙声で尋ねました。

クリストファー・ロビンは考え込みました。「プー、大丈夫。もっと安全で効率的なハチミツAPIを設計し直せばいいんだよ。」

クリストファー・ロビンは地面に木の枝で図を描き始めました。「まず、認証と認可が必要だね。ラビットにも許可を得る必要があるから。」


function getHoneyWithPermission(requester, honeyPotId) {
  if (authorizeHoneyRequest(requester, honeyPotId)) {
    // ラビットの許可を得た場合
    let honey = get_Poohs_Honey(honeyPotId);
    if (honey.status == 200) {
      return { status: 200, honey: honey.honey };
    } else {
      return honey; // 元のエラーを返す
    }
  } else {
    return { status: 403, message: "Rabbit says no! You need permission." };
  }
}

「次に、エラー処理も重要だ。蜂に刺されないように、安全な方法でハチミツを取りに行かないとね。」

「安全な方法…？」プーは首をかしげました。

「そう。例えば、長い棒を使ってハチミツを少しだけ取ってくる、みたいな。」クリストファー・ロビンは説明しました。「そして、レスポンス形式も大事だ。少量でも確実にハチミツを提供できるようにね。」


function get_Poohs_Honey(honeyPotId) {
  if (honeyPotId == "emptyPot") {
      // 安全な方法でハチミツを少しだけ取ってくる
      let smallHoneyAmount = getSmallHoneySafely("ChristopherRobinsPot");
      if (smallHoneyAmount) {
        return { status: 200, honey: smallHoneyAmount, message: "Just a little bit, but enjoy!" };
      } else {
        return { status: 503, message: "Even a small amount isn't available right now." };
      }
  } else if (honeyPotId == "fullPot") {
    return { status: 200, honey: "Yummy golden honey!" };
  }
}

let honey = getHoneyWithPermission("Pooh", "emptyPot");
console.log(honey.message); // "Just a little bit, but enjoy!"

「このコードでは、ハニーポットが空っぽでも、クリストファー・ロビンの壺から少しだけハチミツを取ってくるように変更したんだ。そして、ラビットの許可を得るための関数も追加したんだよ。」クリストファー・ロビンは笑顔でプーに言いました。

プーは少しのハチミツを分けてもらえることになり、喜びました。「ありがとう、クリストファー・ロビン！少しのハチミツでも、僕には十分だよ！」

こうして、プーは安全で効率的なハチミツAPIのおかげで、少しだけですがハチミツを手に入れることができました。クリストファー・ロビンは、良いAPI設計の大切さを改めて実感したのでした。

小さなハニーポットと成功レスポンス

「クリストファー・ロビン…どうしたらハチミツが手に入るんだい？」プーは涙声で尋ねました。

クリストファー・ロビンはにっこり笑って、小さなハニーポットをプーに渡しました。「プー、少しだけ残ってたんだ。よかったね。これは`get_Poohs_Honey_SmallPot()`で取得したものだよ。」


function get_Poohs_Honey_SmallPot() {
  return {
    status: 200,
    honey: "A small pot of yummy honey, just enough for now!",
    servingSize: "small"
  };
}

let honey = get_Poohs_Honey_SmallPot();
console.log(honey.honey); // "A small pot of yummy honey, just enough for now!"

プーは小さな壺のハチミツを一口舐めて、目を輝かせました。「ありがとう、クリストファー・ロビン！少しのハチミツでも、とても美味しいよ！まるで魔法みたいだ！」

「APIは魔法じゃないけど、うまく設計すれば君を幸せにできるんだよ、プー。」クリストファー・ロビンは優しく言いました。「この少量のハチミツは、最適化されたAPIが、必要十分なレスポンスを返すことを意味しているんだ。」

プーは、ハニーポットを大事そうに抱えながら、「クリストファー・ロビンは本当に賢いなぁ」と感心しました。そして、残りのハチミツをゆっくりと味わいました。

クリストファー・ロビンは、プーの満足そうな顔を見て、小さくため息をつきました。「（これでしばらくは静かにしてくれるかな…また緊急度の低いバグ修正に追われる日々が始まるのか…）」