mcpField
A
api-design-principles

api-design-principles

github.com/sickn33開発48.8k1.0k 回インストール今日更新
リポジトリ

api-design-principles について

RESTとGraphQL APIの設計・レビューを支援するスキルです。開発者やチーム向けにAPI契約の指針を示し、実装パターンやチェックリストも提供します。

主な機能

  1. 01RESTとGraphQLの設計指針
  2. 02リソースと型のモデリング
  3. 03エラー・バージョン・ページネーション方針
  4. 04例による仕様と一貫性の確認
  5. 05実装パターンとチェックリスト

活用シーン

  1. 01新しいAPIの設計
  2. 02既存APIのリファクタリング
  3. 03チームのAPI標準策定
  4. 04API仕様のレビュー

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill api-design-principles

インストール後、Claude Code で/api-design-principlesを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

assets/
api-design-checklist.md
rest-api-template.py
references/
rest-best-practices.md
graphql-schema-design.md
resources/
implementation-playbook.md

詳細

API 設計原則

直感的でスケーラブル、かつ保守しやすい API を設計し、開発者に喜ばれ、長く使われ続ける API を構築するために、REST と GraphQL の API 設計原則を習得します。

このスキルを使用する場合

  • 新しい REST または GraphQL API を設計する場合
  • 既存の API をより使いやすくするためにリファクタリングする場合
  • チーム向けの API 設計標準を策定する場合
  • 実装前に API 仕様をレビューする場合
  • API パラダイム間を移行する場合（REST から GraphQL へ、など）
  • 開発者にやさしい API ドキュメントを作成する場合
  • 特定のユースケース（モバイル、サードパーティ連携など）に合わせて API を最適化する場合

このスキルを使用しない場合

  • 特定のフレームワーク向けの実装ガイダンスのみが必要な場合
  • API コントラクトを伴わないインフラストラクチャのみの作業を行う場合
  • 公開インターフェースを変更またはバージョン管理できない場合

手順

  1. 利用者、ユースケース、制約を定義します。
  2. API スタイルを選択し、リソースまたは型をモデル化します。
  3. エラー、バージョン管理、ページネーション、認証戦略を規定します。
  4. 例を用いて検証し、一貫性をレビューします。

詳細なパターン、チェックリスト、テンプレートについては resources/implementation-playbook.md を参照してください。

リソース

  • 詳細なパターン、チェックリスト、テンプレートについては resources/implementation-playbook.md。

制限事項

  • このスキルは、タスクが上記の範囲に明確に一致する場合にのみ使用してください。
  • 出力を、環境固有の検証、テスト、専門家によるレビューの代わりとして扱わないでください。
  • 必要な入力、権限、安全上の境界、成功基準が欠けている場合は、作業を中断して確認を求めてください。

コメント

Markdown 対応