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 @sickn33
The skill is the 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 and stand the test of time.
A short guide to REST and GraphQL API design principles for building APIs that are intuitive, scalable and maintainable. It follows a use-when and do-not-use-when pattern, so you can tell quickly whether the guidance applies.
The original SKILL.md is organised into these sections:
Written and maintained by @sickn33. 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. ## 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 1. Define consumers, use cases, and constraints. 2. Choose API style and model resources or types. 3. Specify errors, versioning, pagination, and auth strategy. …
Excerpt only, quoted from the author's repository. Open the repository for the complete file.