skills sourced live from GitHub · all skills listed are free · each skill is provided under its author's license.
home / API & Integrations / Api Design Principles Skill by @wshobson
The skill is the plugins/backend-development/skills/api-design-principles folder inside that repository. Copy it into the folder your agent loads skills from; check your agent's documentation for where that is.
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers.
A reference the agent can lean on when shaping an API: REST resource design, GraphQL schema design and versioning strategy, followed by a best-practices pass. It is guidance for decisions rather than a code generator, so its value shows up in reviews and design discussions.
The original SKILL.md is organised into these sections:
Written and maintained by @wshobson. It is published under the MIT license, which allows reuse with attribution. See the author profile. SkillDirectory does not claim authorship: this page adds our own review and links back to the original, and the skill's text belongs to its author.
# API 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. ## When to Use This Skill - 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) ## Core Concepts ### 1. RESTful Design Principles **Resource-Oriented Architecture** - Resources are nouns (users, orders, products), not verbs - Use HTTP methods for actions (GET, POST, PUT, PATCH, DELETE) - URLs represent resource hierarchies - Consistent naming conventions **HTTP Methods Semantics:** - `GET`: Retrieve resources (idempotent, safe) - `POST`: Create new resources …
Excerpt only, quoted from the author's repository. Open the repository for the complete file.