Communitygithub.com

API設計原則

直感的でスケーラブルかつ保守しやすいAPIを構築するためのRESTおよびGraphQL API設計原則を習得します。新しいAPIの設計時、API仕様のレビュー時、またはAPI設計標準の確立時に使用します。

API設計原則 とは?

このスキルは、RESTとGraphQLのAPI設計原則に関する深い知識とベストプラクティスを提供します。新しいAPIの設計、既存APIのリファクタリング、チームのAPI設計標準の確立、API仕様のレビュー、APIパラダイム間の移行(RESTからGraphQLなど)、開発者に優しいAPIドキュメントの作成、モバイルやサードパーティ統合などの特定のユースケース向けの最適化に役立ちます。具体的には、利用者、ユースケース、制約の定義、APIスタイルの選択とリソース/タイプのモデル化、エラー、バージョニング、ページネーション、認証戦略の指定、例による検証と一貫性のレビューといったステップをガイドします。特定のフレームワークの実装ガイダンスのみが必要な場合や、APIコントラクトなしのインフラ作業のみを行う場合、パブリックインターフェースを変更またはバージョン管理できない場合には使用すべきではありません。詳細なパターン、チェックリスト、テンプレートは `resources/implementation-playbook.md` で提供されています。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Anmolop97/Agent-Skills/tree/HEAD/skills/api-design-principles

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

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:詳細なパターン、チェックリスト、テンプレート

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

Anmolop97/Agent-Skills

Searches, installs, updates, and lists skills from the Antigravity Skill Vault. Use when choosing or managing workspace or global skills through the npm CLI.

Anmolop97/Agent-Skills

Master authentication and authorization patterns including JWT, OAuth2, session management, and RBAC to build secure, scalable access control systems. Use when implementing auth systems, securing APIs, or debugging security issues.

Anmolop97/Agent-Skills

Reference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIR...

Anmolop97/Agent-Skills

Searches, installs, updates, and lists skills from the Antigravity Skill Vault. Use when choosing or managing workspace or global skills through the npm CLI.

関連スキル