Api Patterns

1---2name: api-patterns3description: "API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination."4risk: unknown5source: community6date_added: "2026-02-27"7---8 9# API Patterns10 11> API design principles and decision-making for 2025.12> **Learn to THINK, not copy fixed patterns.**13 14## 🎯 Selective Reading Rule15 16**Read ONLY files relevant to the request!** Check the content map, find what you need.17 18---19 20## 📑 Content Map21 22| File | Description | When to Read |23|------|-------------|--------------|24| `api-style.md` | REST vs GraphQL vs tRPC decision tree | Choosing API type |25| `rest.md` | Resource naming, HTTP methods, status codes | Designing REST API |26| `response.md` | Envelope pattern, error format, pagination | Response structure |27| `graphql.md` | Schema design, when to use, security | Considering GraphQL |28| `trpc.md` | TypeScript monorepo, type safety | TS fullstack projects |29| `versioning.md` | URI/Header/Query versioning | API evolution planning |30| `auth.md` | JWT, OAuth, Passkey, API Keys | Auth pattern selection |31| `rate-limiting.md` | Token bucket, sliding window | API protection |32| `documentation.md` | OpenAPI/Swagger best practices | Documentation |33| `security-testing.md` | OWASP API Top 10, auth/authz testing | Security audits |34 35---36 37## 🔗 Related Skills38 39| Need | Skill |40|------|-------|41| API implementation | `@[skills/backend-development]` |42| Data structure | `@[skills/database-design]` |43| Security details | `@[skills/security-hardening]` |44 45---46 47## ✅ Decision Checklist48 49Before designing an API:50 51- [ ] **Asked user about API consumers?**52- [ ] **Chosen API style for THIS context?** (REST/GraphQL/tRPC)53- [ ] **Defined consistent response format?**54- [ ] **Planned versioning strategy?**55- [ ] **Considered authentication needs?**56- [ ] **Planned rate limiting?**57- [ ] **Documentation approach defined?**58 59---60 61## ❌ Anti-Patterns62 63**DON'T:**64- Default to REST for everything65- Use verbs in REST endpoints (/getUsers)66- Return inconsistent response formats67- Expose internal errors to clients68- Skip rate limiting69 70**DO:**71- Choose API style based on context72- Ask about client requirements73- Document thoroughly74- Use appropriate status codes75 76---77 78## Script79 80| Script | Purpose | Command |81|--------|---------|---------|82| `scripts/api_validator.py` | API endpoint validation | `python scripts/api_validator.py <project_path>` |83 84## When to Use85This skill is applicable to execute the workflow or actions described in the overview.86 87## Limitations88- Use this skill only when the task clearly matches the scope described above.89- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.90- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.