api-design-principles

Solid

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

API & Backend 39,350 stars 6386 forks Updated today MIT

Install

View on GitHub

Quality Score: 97/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
61
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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.

Details

Author
sickn33
Repository
sickn33/antigravity-awesome-skills
Created
4 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category