mcpField
A
api-patterns

api-patterns

github.com/vudovnDevelopment8.2k204 installsUpdated 10w ago
Repository

About api-patterns

api-patterns is a decision guide for API designers, covering API styles, response structures, security, and evolution. It also includes a script for validating API endpoints.

Key features

  1. 01REST, GraphQL, and tRPC selection
  2. 02Resource naming and HTTP status guidance
  3. 03Response formats and pagination
  4. 04Versioning and authentication options
  5. 05Rate limiting, security testing, and documentation
  6. 06API endpoint validation script

Use cases

  1. 01Choose an API style for a project
  2. 02Plan consistent responses and versioning
  3. 03Assess authentication, rate limiting, and security testing
  4. 04Validate API endpoints with the script

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/vudovn/ag-kit --skill api-patterns

After installing, type/api-patternsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with 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

Details

From the project README

API Patterns

API design principles and decision-making. 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/nodejs-best-practices]
Data structure@[skills/database-design]
Security details@[skills/vulnerability-scanner]

✅ 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>

Comments

Markdown supported