api-design-principles · sickn33 — Claude Code skill: REST and GraphQL
Skill for designing REST and GraphQL APIs from scratch: architecture, versioning, error handling, and authentication that make APIs pleasant for other developers to consume.
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-codeWhat api-design-principles does
The skill walks you through API design before you code: define consumers and constraints, choose between REST or GraphQL, model resources or types, specify error strategies, versioning, pagination, and auth. You work through it in conversation with an agent.
Inside: a four-step process and resources/implementation-playbook.md with patterns, checklists, and templates. Runs on Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode.
Use it when designing a new API, refactoring an existing one for developer experience, setting team standards, or preparing a spec for review. Skip it if you need implementation guidance for a specific framework or if you cannot modify public interfaces.
What it helps with
- design a REST API with versioning and error handling
- decide between REST and GraphQL for your use case
- structure resources and data types consistently
- establish API standards across a team
- prepare APIs for third-party integrations
Example prompts for the agent
- Design a REST API for a mobile app with offline sync
- Rethink our GraphQL schema: how do we handle pagination for large datasets?
- Create API documentation with error examples and rate limiting
How to install api-design-principles
1Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-code2Manually: put the files in place
~/.claude/skills/api-design-principles/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/api-design-principles/
1Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a codex2Manually: put the files in place
.agents/skills/api-design-principles/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a cursor2Manually: put the files in place
.cursor/skills/api-design-principles/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install sickn33/agentic-awesome-skills api-design-principles2Manually: put the files in place
.github/skills/api-design-principles/SKILL.md1Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a gemini-cli2Platform CLI
gemini skills install https://github.com/sickn33/agentic-awesome-skills --path skills/api-design-principlesManually: put the files in place
.devin/skills/api-design-principles/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
From the same set80
The whole set →Other versions of api-design-principles
Similar
Questions about api-design-principles
How do I install api-design-principles in Claude Code?
Run npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-code, then find the installed skill at ~/.claude/skills/api-design-principles/SKILL.md.
What does this skill do?
It helps you design a REST or GraphQL API: define consumers, choose an architecture, specify error handling, versioning, pagination, and auth strategy. Works as a conversation with an agent, pulling from built-in patterns and templates.
When should I skip this skill?
If you need implementation help for a specific framework (Django, FastAPI, Express), if the task is infrastructure-only without API contracts, or if you cannot change your public interfaces.
Source text
SKILL.md · MIT
--- name: api-design-principles description: "Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time." risk: safe source: community date_added: "2026-02-27" --- # 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. 4. 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. ## Limitations - Use this skill only when the task clearly matches the scope described above. - Do not treat the output as a substitute for environment-specific validation, testing, or expert review. - Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
© sickn33 · MIT · sickn33/agentic-awesome-skills