Name: api-patterns
Author: writingafterdev

Imported from writingafterdev/vocab-builder (vocab-builder/.agent/skills/api-patterns/SKILL.md). Install upstream with npx skills add writingafterdev/vocab-builder --skill api-patterns. Copyright stays with the author.

API Patterns

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

File	Description	When to Read
`api-style.md`	REST vs GraphQL vs tRPC decision tree	Choosing API type
`rest.md`	Resource naming, HTTP methods, status codes	Designing REST API
`response.md`	Envelope pattern, error format, pagination	Response structure
`graphql.md`	Schema design, when to use, security	Considering GraphQL
`trpc.md`	TypeScript monorepo, type safety	TS fullstack projects
`versioning.md`	URI/Header/Query versioning	API evolution planning
`auth.md`	JWT, OAuth, Passkey, API Keys	Auth pattern selection
`rate-limiting.md`	Token bucket, sliding window	API protection
`documentation.md`	OpenAPI/Swagger best practices	Documentation
`security-testing.md`	OWASP API Top 10, auth/authz testing	Security audits

🔗 Related Skills

Need	Skill
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

Script	Purpose	Command
`scripts/api_validator.py`	API endpoint validation	`python scripts/api_validator.py <project_path>`

Install api-patterns and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

{ "ocm": "1", "id": "writingafterdev-vocab-builder-api-patterns", "kind": "skill", "name": "api-patterns", "description": "API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.", "publisher": "writingafterdev", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination." ], "primary": false, "metadata": { "source": { "provider": "github", "repository": "https://github.com/writingafterdev/vocab-builder", "path": "vocab-builder/.agent/skills/api-patterns/SKILL.md", "ref": "23be22cbb9b83969f1f0986012ae6bbfed980a1e", "url": "https://github.com/writingafterdev/vocab-builder/blob/23be22cbb9b83969f1f0986012ae6bbfed980a1e/vocab-builder/.agent/skills/api-patterns/SKILL.md", "key": "writingafterdev/vocab-builder/vocab-builder/.agent/skills/api-patterns/SKILL.md" }, "allowed_tools": [ "Read,", "Write,", "Edit,", "Glob,", "Grep" ] }, "instructions": "# API Patterns\n\n> API design principles and decision-making for 2025.\n> **Learn to THINK, not copy fixed patterns.**\n\n## 🎯 Selective Reading Rule\n\n**Read ONLY files relevant to the request!** Check the content map, find what you need.\n\n---\n\n## 📑 Content Map\n\n| File | Description | When to Read |\n|------|-------------|--------------|\n| `api-style.md` | REST vs GraphQL vs tRPC decision tree | Choosing API type |\n| `rest.md` | Resource naming, HTTP methods, status codes | Designing REST API |\n| `response.md` | Envelope pattern, error format, pagination | Response structure |\n| `graphql.md` | Sche", "cost": { "context_tokens": 553 } }

api-patterns

About

API Patterns

🎯 Selective Reading Rule

📑 Content Map

🔗 Related Skills

✅ Decision Checklist

❌ Anti-Patterns

Script

Install api-patterns and it becomes one more candidate the router can pick - when it fits.

Use it

Manifest

Reviews