FIELD NOTES FOR AI-ERA DEVELOPERS

AI開発メモ

「AIを使え」に、現場の地に足ついた一歩で応える開発メディア

無料ツール|印刷用チェックリスト

AIにAPIエンドポイント設計を叩かせるチェックリスト

  • 操作するリソースと操作一覧(一覧・取得・作成・更新・削除など)を渡したか
  • 誰が・何から使うAPIか(自社画面・アプリ・外部公開)を伝えたか
  • 既存APIの命名・バージョンの流儀を渡したか
  • 本番URL・トークン・認証情報を貼らずに、構造だけで相談したか
  • 「唯一解」でなく「案を2つ+向き不向き」で出させたか
  • メソッド・パス・意味・ステータスコードを表で明示させたか
  • パスが名詞中心で、動詞をURLに埋めていないか確かめたか
  • 粒度が細かすぎ・粗すぎないか、両側から指摘させたか
  • 存在しない・不正・権限なしの返し方を、API全体で統一させたか
  • 提案の「なぜ」を自分の言葉で説明できるか確かめたか

この内容は記事「AIにAPIエンドポイント設計を叩かせる|命名と粒度の詰め方」のチェックリストです。印刷してそのままお使いいただけます。 / 無料ツール一覧へ