API設計原則 は何をしますか?
直感的でスケーラブルかつ保守しやすいAPIを構築し、開発者を喜ばせ、時代に耐えるRESTおよびGraphQL API設計原則を習得します。
このスキルを使用する場面
- 新しいRESTまたはGraphQL APIの設計時
- 既存のAPIのユーザビリティ向上のためのリファクタリング時
- チームのAPI設計標準の確立時
- 実装前のAPI仕様のレビュー時
- APIパラダイム間の移行時(RESTからGraphQLなど)
- 開発者に優しいAPIドキュメントの作成時
- 特定のユースケース向けのAPI最適化時(モバイル、サードパーティ統合など)
このスキルを使用しない場面
- 特定のフレームワークの実装ガイダンスのみが必要な場合
- APIコントラクトなしのインフラ作業のみを行う場合
- パブリックインターフェースを変更またはバージョン管理できない場合
手順
- 利用者、ユースケース、制約を定義します。
- APIスタイルを選択し、リソースまたはタイプをモデル化します。
- エラー、バージョニング、ページネーション、認証戦略を指定します。
- 例を使用して検証し、一貫性を確認します。
詳細なパターン、チェックリスト、テンプレートについては、resources/implementation-playbook.md を参照してください。
リソース
resources/implementation-playbook.md:詳細なパターン、チェックリスト、テンプレート