mcpField
A
api-patterns

api-patterns

github.com/vudovn開発8.2k204 回インストール10 週間前に更新
リポジトリ

api-patterns について

api-patterns は、API 設計者向けの判断ガイドです。API の方式、レスポンス構造、セキュリティ、変更管理を扱い、エンドポイント検証スクリプトも含みます。

主な機能

  1. 01REST、GraphQL、tRPC の選択
  2. 02リソース命名と HTTP ステータスの指針
  3. 03レスポンス形式とページネーション
  4. 04バージョン管理と認証方式
  5. 05レート制限、セキュリティテスト、文書化
  6. 06API エンドポイント検証スクリプト

活用シーン

  1. 01プロジェクトに適した API 方式の選択
  2. 02一貫したレスポンスとバージョン戦略の策定
  3. 03認証、レート制限、セキュリティテストの検討
  4. 04スクリプトによる API エンドポイントの検証

インストール

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

$npx skills add https://github.com/vudovn/ag-kit --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 パターン

API 設計の原則と意思決定。 決まったパターンをコピーするのではなく、考え方を身につけましょう。

🎯 必要なファイルだけ読むルール

リクエストに関連するファイルだけを読んでください！ コンテンツマップを確認し、必要な情報を探します。

📑 コンテンツマップ

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

🔗 関連スキル

必要なものスキル
API の実装@[skills/nodejs-best-practices]
データ構造@[skills/database-design]
セキュリティの詳細@[skills/vulnerability-scanner]

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

API を設計する前に、以下を確認してください。

  • API の利用者についてユーザーに確認しましたか？
  • この状況に適した API スタイルを選びましたか？ （REST／GraphQL／tRPC）
  • 一貫性のあるレスポンス形式を定義しましたか？
  • バージョニング戦略を計画しましたか？
  • 認証の要件を検討しましたか？
  • レート制限を計画しましたか？
  • ドキュメントの作成方針を定義しましたか？

❌ アンチパターン

避けること：

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

実施すること：

  • 状況に応じて API スタイルを選ぶ
  • クライアントの要件を確認する
  • ドキュメントを徹底的に作成する
  • 適切なステータスコードを使用する

スクリプト

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

コメント

Markdown 対応