mcpField
A
api-design-principles

api-design-principles

github.com/rmyndharis開発2.0k95 回インストール1 日前に更新
リポジトリ

api-design-principles について

api-design-principlesは、RESTやGraphQL APIを設計・レビュー・改修する開発者やチーム向けのスキルです。利用者の要件やAPI形式の選定から、エラー、バージョン、ページネーション、認証方針まで扱います。

主な機能

  1. 01REST・GraphQLの設計指針
  2. 02利用者と制約に基づくAPI計画
  3. 03エラー・バージョン・ページネーション方針
  4. 04例を用いた一貫性の検証

活用シーン

  1. 01新しいRESTまたはGraphQL APIの設計
  2. 02実装前のAPI仕様レビュー
  3. 03チームのAPI設計基準の策定

インストール

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

$npx skills add https://github.com/rmyndharis/antigravity-skills --skill api-design-principles

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

同梱ファイル

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

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

詳細

API設計の原則

REST および GraphQL の API 設計原則を習得し、開発者に喜ばれ、長く使い続けられる、直感的でスケーラブルかつ保守しやすい 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 対応