API Design Principles
SkillMediaGuides your agent in designing clear, well-structured REST or GraphQL APIs with resources, errors, versioning, and auth.
Use API Design Principles in Claude, ChatGPT or Ahel Desktop
Free. Sign in, add API Design Principles and connect your AI. About a minute.
Also: Claude Code · Cursor · Codex
Then ask your AI: use the API Design Principles skill
Details
Instructions available. Your AI can read the instructions. Execution depends on the setup they require.
Account requirements not reviewed. Check the skill instructions before use; ahel provides instructions and does not run this skill.
No other account needed.
Add ahel to your AI once: Claude, ChatGPT, Cursor, Claude Code or Codex. Then ask it to use this.
About this skill
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
What this skill tells your AI
The instructions your AI receives, as published by lingxling/awesome-skills-cn in antigravity-awesome-skills/skills/api-design-principles/SKILL.md and read by ahel’s review.
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.mdfor 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.
Signals
- GitHub stars
- 295
- Forks
- 51
- Last commit
- Jul 2026
ahel recommends instead
Advanced
- Item type
- skill
- Key
api-design-principles-lingxling- Source
- github.com/lingxling/awesome-skills-cn
github.com/lingxling/awesome-skills-cn