/dashboard/public/component-content/skills/development/api-design-principles.json

{"content": "---\nname: api-design-principles\ndescription: \"Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.\"\nrisk: safe\nsource: community\ndate_added: \"2026-02-27\"\n---\n\n# API Design Principles\n\nMaster REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.\n\n## Use this skill when\n\n- Designing new REST or GraphQL APIs\n- Refactoring existing APIs for better usability\n- Establishing API design standards for your team\n- Reviewing API specifications before implementation\n- Migrating between API paradigms (REST to GraphQL, etc.)\n- Creating developer-friendly API documentation\n- Optimizing APIs for specific use cases (mobile, third-party integrations)\n\n## Do not use this skill when\n\n- You only need implementation guidance for a specific framework\n- You are doing infrastructure-only work without API contracts\n- You cannot change or version public interfaces\n\n## Instructions\n\n1. Define consumers, use cases, and constraints.\n2. Choose API style and model resources or types.\n3. Specify errors, versioning, pagination, and auth strategy.\n4. Validate with examples and review for consistency.\n\nRefer to `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.\n\n## Resources\n\n- `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.\n"}