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.md for detailed patterns, checklists, and templates.
1---2name: api-design-principles3description: API Design Principles4---5# API Design Principles67Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.89## Use this skill when1011- Designing new REST or GraphQL APIs12- Refactoring existing APIs for better usability13- Establishing API design standards for your team14- Reviewing API specifications before implementation15- Migrating between API paradigms (REST to GraphQL, etc.)16- Creating developer-friendly API documentation17- Optimizing APIs for specific use cases (mobile, third-party integrations)1819## Do not use this skill when2021- You only need implementation guidance for a specific framework22- You are doing infrastructure-only work without API contracts23- You cannot change or version public interfaces2425## Instructions26271. Define consumers, use cases, and constraints.282. Choose API style and model resources or types.293. Specify errors, versioning, pagination, and auth strategy.304. Validate with examples and review for consistency.3132Refer to `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.3334## Resources3536- `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.
Run npx skillmds@latest add comeonoliver/api-design-principles in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
API Design Principles It is listed under Integrations & APIs on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
ComeOnOliver (@comeonoliver) published this skill. Their other Agent Skills are listed on their SkillMD profile.
ComeOnOliver