← 一覧へ
コーディングCC / Codex 両対応難易度: 中級
APIとインターフェース設計 api-and-interface-design
安心して使えるAPIとインターフェースを一緒に設計しよう！
これは何？
これは、使いやすくてわかりやすいインターフェースを設計するためのスキルです。APIやモジュールの境界、パブリックなインターフェースを設計する時に役立ちます。良いインターフェースは、正しいことを簡単に、間違いを難しくするものです。REST APIやGraphQLスキーマ、コンポーネントのプロパティなど、コード同士がやり取りする場所すべてに応用できます。
これでできること
- 新しいAPIエンドポイントを設計する
- チーム間のモジュール境界や契約を定義する
- コンポーネントのプロパティインターフェースを作成する
- APIの形状を決定するデータベーススキーマを確立する
- 既存のパブリックインターフェースを変更する
こんな時に便利
新しいAPIエンドポイントを設計する時
チーム間でモジュールの境界を定める時
コンポーネントのプロパティインターフェースを作成する時
APIの形状を決定するデータベーススキーマを作成する時
既存のパブリックインターフェースを変更する時
使い方
まず、設計するインターフェースの目的を明確にします。次に、使いやすくてミスを防ぐためのルールを決め、ドキュメントを作成します。最後に、実際に使ってみて問題がないか確認しましょう。
必要なもの
- 特になし
導入方法
いちばん簡単（AIに頼む）
次のスキルを入れて: https://github.com/addyosmani/agent-skills/tree/main/skills/api-and-interface-design手動で置く
Claude Code →
~/.claude/skills/api-and-interface-design/Codex →
~/.agents/skills/api-and-interface-design/使いこなしのコツ
- APIを設計したら、全てのエンドポイントに型付きの入力と出力スキーマを用意しよう
- エラーレスポンスは一貫したフォーマットに統一しよう
- バリデーションはシステムの境界でのみ行おう