← 一覧へ
🛠 コードを作るCC / Codex 両対応難易度: 中級
REST API設計 api-design
誰でもわかる優しいAPI設計
これは何？
これは、REST APIを設計するためのガイドです。初心者でもわかるように、エンドポイントの設計からエラーハンドリングまで、丁寧に説明します。APIを作るときや既存のAPIを見直すときに役立ちます。
これでできること
- APIエンドポイントを設計する
- 適切なHTTPステータスコードを選択する
- ページネーションやフィルタリングを実装する
- エラーハンドリングを強化する
こんな時に便利
新しいAPIを設計するとき
既存のAPIを見直すとき
ページネーションやフィルタリングを追加するとき
APIのバージョン管理を計画するとき
使い方
まずは基本のAPIエンドポイントの設計から始めましょう。URLの命名規則やHTTPメソッドの使い方を学びます。次に、ステータスコードやエラーハンドリングについて理解を深めましょう。
使用例（こう頼んでみよう）
REST APIエンドポイントの設計例を教えてくださいページネーションを実装する方法を教えてくださいエラーハンドリングのベストプラクティスを教えてください必要なもの
- 特になし
導入方法
いちばん簡単（AIに頼む）
次のスキルを入れて: https://github.com/affaan-m/ECC/tree/main/.agents/skills/api-design手動で置く
Claude Code →
~/.claude/skills/api-design/Codex →
~/.agents/skills/api-design/使いこなしのコツ
- URLは名詞の複数形で、ケバブケースを使いましょう
- HTTPステータスコードは意味的に正しいものを選びましょう
- ページネーションはカーソルベースがおすすめです