api-design-principles

Documentation & Productivité

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

Documentation

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.

Compétences similaires

Explorez d'autres agents de la catégorie Documentation & Productivité

Voir tout le catalogue

data-quality-frameworks

Implement data quality validation with Great Expectations, dbt tests, and data contracts. Use when building data quality pipelines, implementing validation rules, or establishing data contracts.

VOIR LA FICHE

error-handling-patterns

Master error handling patterns across languages including exceptions, Result types, error propagation, and graceful degradation to build resilient applications. Use when implementing error handling, designing APIs, or improving application reliability.

VOIR LA FICHE

turborepo-caching

Configure Turborepo for efficient monorepo builds with local and remote caching. Use when setting up Turborepo, optimizing build pipelines, or implementing distributed caching.

VOIR LA FICHE
Utiliser l'Agent api-design-principles - Outil & Compétence IA | Skills Catalogue | Skills Catalogue