mcpField
A
api-patterns

api-patterns

github.com/davila7開発33.0k486 回インストール今日更新
リポジトリ

api-patterns について

api-patternsは、APIの設計方針を選ぶ開発者向けスキルです。テーマ別のリファレンス、判断チェックリスト、エンドポイント検証スクリプトで構成されています。

主な機能

  1. 01REST、GraphQL、tRPCの選択ガイド
  2. 02RESTのリソース名とHTTPメソッドの指針
  3. 03レスポンス、エラー、ページネーションのパターン
  4. 04バージョニング、認証、レート制限
  5. 05OpenAPI文書化とセキュリティテスト
  6. 06エンドポイント検証スクリプト

活用シーン

  1. 01プロジェクトに適したAPI形式の選択
  2. 02一貫したレスポンス形式とAPIバージョンの計画
  3. 03認証とレート制限方式の選定
  4. 04APIエンドポイントの検証

インストール

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

$npx skills add https://github.com/davila7/claude-code-templates --skill api-patterns

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

同梱ファイル

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

api-style.md
auth.md
documentation.md
graphql.md
rate-limiting.md
response.md
rest.md
security-testing.md
trpc.md
versioning.md
scripts/
api_validator.py

詳細

API パターン

2025年の API 設計の原則と意思決定。 固定パターンをコピーするのではなく、考え方を学ぶ。

🎯 選択的読み取りルール

リクエストに関連するファイルのみを読んでください！ コンテンツマップを確認し、必要なものを見つけてください。

📑 コンテンツマップ

ファイル説明読むタイミング
api-style.mdREST と GraphQL と tRPC の判断ツリーAPI の種類を選ぶとき
rest.mdリソース命名、HTTP メソッド、ステータスコードREST API を設計するとき
response.mdエンベロープパターン、エラー形式、ページネーションレスポンス構造
graphql.mdスキーマ設計、使用場面、セキュリティGraphQL を検討するとき
trpc.mdTypeScript モノレポ、型安全性TS フルスタックプロジェクト
versioning.mdURI/ヘッダー/クエリによるバージョニングAPI の進化計画
auth.mdJWT、OAuth、Passkey、API キー認証パターンの選択
rate-limiting.mdトークンバケット、スライディングウィンドウAPI の保護
documentation.mdOpenAPI/Swagger のベストプラクティスドキュメント
security-testing.mdOWASP API Top 10、認証/認可のテストセキュリティ監査

🔗 関連スキル

必要なものスキル
API の実装@[skills/backend-development]
データ構造@[skills/database-design]
セキュリティの詳細@[skills/security-hardening]

✅ 意思決定チェックリスト

API を設計する前に:

  • API の利用者についてユーザーに確認したか？
  • 今回の状況に合った API スタイルを選んだか？ (REST/GraphQL/tRPC)
  • 一貫したレスポンス形式を定義したか？
  • バージョニング戦略を計画したか？
  • 認証の必要性を検討したか？
  • レート制限を計画したか？
  • ドキュメントのアプローチを定義したか？

❌ アンチパターン

やってはいけないこと:

  • 何にでも REST をデフォルトで使う
  • REST のエンドポイントに動詞を使う (/getUsers)
  • 一貫性のないレスポンス形式を返す
  • 内部エラーをクライアントに公開する
  • レート制限を省略する

推奨:

  • 状況に基づいて API スタイルを選ぶ
  • クライアントの要件を確認する
  • ドキュメントを十分に整備する
  • 適切なステータスコードを使用する

スクリプト

スクリプト目的コマンド
scripts/api_validator.pyAPI エンドポイントの検証python scripts/api_validator.py <project_path>

コメント

Markdown 対応