receiving-code-review
OBobra/superpowers298k2,631 new stars in the last 7 days
api-design-principles
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.
- Star
- 1,750
- Category
- Coding & debugging
- License
- MIT
- Last commit
- Oct 1, 2026
skills/api-design-principles/SKILL.md
View on GitHubAPI Design Principles
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
Use this skill when
- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)
Do not use this skill when
- You only need implementation guidance for a specific framework
- You are doing infrastructure-only work without API contracts
- You cannot change or version public interfaces
Instructions
- Define consumers, use cases, and constraints.
- Choose API style and model resources or types.
- Specify errors, versioning, pagination, and auth strategy.
- Validate with examples and review for consistency.
Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates.
Resources
resources/implementation-playbook.mdfor detailed patterns, checklists, and templates.
Similar Skills
requesting-code-review
OBobra/superpowers298k2,631 new stars in the last 7 days
systematic-debugging
OBobra/superpowers298k2,631 new stars in the last 7 days
code-review
MAmattpocock/skills288k10,178 new stars in the last 7 days
codebase-design
MAmattpocock/skills288k10,178 new stars in the last 7 days
scaffold-exercises
MAmattpocock/skills288k10,178 new stars in the last 7 days