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

documentation-generation-doc-generate

"You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices."

VOIR LA FICHE

analytics-tracking

>

VOIR LA FICHE

api-patterns

API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.

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