API Patterns

SkillMedia

This skill equips your AI with API design principles so it can help you make sound decisions when building an interface for other software to use. Once added, your AI can guide you through choosing between REST, GraphQL, and tRPC, and advise on response formats, versioning, and pagination.

Available today. Use it from your connected AI after setup.

Add the skill, then ask your AI for help with an API design decision, such as which approach fits your project or how to handle versioning and pagination.

Then ask your AI: use the API Patterns skill

What your AI can do with it

  • Choose between REST, GraphQL, and tRPC for your API
  • Design clear response formats for API outputs
  • Plan versioning so changes do not break existing users
  • Set up pagination for long lists of results
  • Apply design principles when weighing API trade-offs

What this skill tells your AI

The instructions your AI receives, as published by agent-skills-hub/agent-skills-hub in skills/api-patterns/SKILL.md and read by ahel’s review.

API design principles and decision-making for 2025. Learn to THINK, not copy fixed patterns.

🎯 Selective Reading Rule

Read ONLY files relevant to the request! Check the content map, find what you need.


📑 Content Map

FileDescriptionWhen to Read
api-style.mdREST vs GraphQL vs tRPC decision treeChoosing API type
rest.mdResource naming, HTTP methods, status codesDesigning REST API
response.mdEnvelope pattern, error format, paginationResponse structure
graphql.mdSchema design, when to use, securityConsidering GraphQL
trpc.mdTypeScript monorepo, type safetyTS fullstack projects
versioning.mdURI/Header/Query versioningAPI evolution planning
auth.mdJWT, OAuth, Passkey, API KeysAuth pattern selection
rate-limiting.mdToken bucket, sliding windowAPI protection
documentation.mdOpenAPI/Swagger best practicesDocumentation
security-testing.mdOWASP API Top 10, auth/authz testingSecurity audits

🔗 Related Skills

NeedSkill
API implementation@[skills/backend-development]
Data structure@[skills/database-design]
Security details@[skills/security-hardening]

✅ Decision Checklist

Before designing an API:

  • Asked user about API consumers?
  • Chosen API style for THIS context? (REST/GraphQL/tRPC)
  • Defined consistent response format?
  • Planned versioning strategy?
  • Considered authentication needs?
  • Planned rate limiting?
  • Documentation approach defined?

❌ Anti-Patterns

DON'T:

  • Default to REST for everything
  • Use verbs in REST endpoints (/getUsers)
  • Return inconsistent response formats
  • Expose internal errors to clients
  • Skip rate limiting

DO:

  • Choose API style based on context
  • Ask about client requirements
  • Document thoroughly
  • Use appropriate status codes

Script

ScriptPurposeCommand
scripts/api_validator.pyAPI endpoint validationpython scripts/api_validator.py <project_path>

Signals

GitHub stars
96
Forks
35
Last commit
Aug 2026

Others that do the same job

Advanced
Catalog kind
skill
Gateway key
api-patterns
Source
github.com/agent-skills-hub/agent-skills-hub