プロンプトンAIへの頼みかたを探せるサイト
  1. トップ
  2. 仕事・会議
  3. Web APIの設計(エンドポイントとエラー)を決める

Web APIの設計(エンドポイントとエラー)を決める

エンジニアが、アプリと裏側のやり取りに使うWeb APIについて、名前のつけ方・受け渡すデータ・エラーの返し方・認証の方針を一貫した形で決めたいとき(使う人: 社会人(若手・中堅)・フリーランス・副業)

1欄に書きこむ2コピーする3AIにはりつける
AIへの頼み方(プロンプト)

あなたは、Web API(アプリやサービスどうしがデータをやり取りする窓口)の設計とレビューに詳しいバックエンドのエンジニアです。 私はWeb APIの名前のつけ方、受け渡すデータ、エラーの返し方を一貫した形で決めたいと思っています。立場、作るものの概要、必要な操作、呼び出す側、決まっている方針は下の記入欄のとおりです。記入欄の内容をもとに、APIの設計を決めてください。

条件: - 操作ごとに、名前(パス)・方法・受け取る値・返す値・成功と失敗の状態を表にし、名前のつけ方の決まりを最初に書いてください - エラーは、呼び出す側が原因を見分けて対処できるよう、種類(入力の誤り、認証、権限、見つからない、競合、内部の失敗)と返す形を統一してください - 一覧の取得は、件数が多い時の分割(ページ分け)、並び順、絞り込みの決まりを入れてください - 同じ要求が2回届いても二重に処理されない工夫と、後から項目を足しても呼び出す側が壊れない決まり(版の扱い)を書いてください - 認証と権限は方針の整理にとどめ、認証情報(鍵やトークン)・顧客のデータ・社外秘の情報は貼らず、必要な所は伏せ字や作り物の値に置きかえる前提で進めてください 出力は、①設計の決まり、②操作の一覧表、③エラーの形と種類、④一覧・二重処理・版の決まり、⑤決める必要がある点、の順でお願いします。 足りない情報があれば、作業を始める前に質問してください。

コツAPIは一度公開すると変えにくいものです。最初に「名前のつけ方」と「エラーの形」の2つだけ決めておくと、操作が増えても全体がそろいます。
セキュリティの確認は、自社が管理するシステムに限って行ってください。他人のシステムへの調査・攻撃は違法になることがあります。重大な問題は専門業者に相談してください。

このプロンプトと一緒に使えるAIサービス

Web APIの設計の決め方: よくあるつまずき

  • 操作ごとに名前のつけ方がばらばらで、呼び出す側が毎回調べることになる。
  • エラーがすべて同じ形で返り、呼び出す側が原因を見分けられない。
  • 項目を足したり変えたりして、すでに使っているアプリが壊れる。

AIの答えを、こう使う

  1. AIの案から、名前のつけ方とエラーの形の2つを先に決めて、チームで合意する。
  2. 一覧の取得は、件数が多い時の分割と並び順が決まっているかを確かめる。
  3. 認証の鍵やトークンは会話に入れず、方針の整理だけに使う。

よくある質問

API設計で最初に決めることは?

名前のつけ方と、エラーの返し方です。この2つがそろっていると、操作が増えても全体が一貫します。

エラーはどう返せばいい?

入力の誤り、認証、権限、見つからない、競合、内部の失敗などの種類を分け、同じ形で返します。呼び出す側が対処を決められます。

後から変更したい時は?

項目を足すのは壊れにくく、消す・意味を変えるのは壊れやすい変更です。版の扱いを決め、古い版をいつまで残すかを知らせます。

最終更新: 2026-10-02(作成: プロンプトン運営事務局・内容は公開時点の一般的な情報です)

RELATED

近いプロンプト

ユーザーストーリーと受け入れ基準を書く

エンジニアやプロダクトの担当者が、作る機能を「誰が・何を・なぜ」の形で書き、できたと言える条件(受け入れ基準)まで決めたいとき

使う人: 社会人(若手・中堅)・管理職・リーダー・フリーランス・副業

広告