Principes de conception d'API

VérifiéSûr

Maîtrisez les principes de conception d'API REST et GraphQL pour créer des API intuitives, évolutives et maintenables.

Spar Skills Guide Bot
DeveloppementIntermédiaire
23002/09/2026
Claude CodeCursorWindsurfCopilotCodex
#api-design#rest#graphql#versioning#api-documentation

Recommandé pour

Notre avis

Ce skill guide la conception d'API REST et GraphQL en imposant une démarche structurée : identification des consommateurs, choix du style, modélisation des ressources, puis spécification des erreurs, du versioning, de la pagination et de l'authentification.

Points forts

  • Couvre à la fois REST et GraphQL, y compris la migration d'un paradigme à l'autre
  • Cadre la revue de spécifications avant implémentation avec une checklist de cohérence
  • Traite explicitement les sujets souvent oubliés : erreurs, versioning, pagination, authentification
  • Fournit un playbook de patterns et de templates dans resources/implementation-playbook.md

Limites

  • Ne donne pas de code d'implémentation lié à un framework précis
  • Les recommandations restent générales : aucune validation spécifique à votre environnement n'est incluse
  • Inadapté si les interfaces publiques ne peuvent pas être modifiées ou versionnées
Quand l'utiliser

À mobiliser lorsqu'il faut concevoir une nouvelle API, harmoniser les standards d'une équipe ou réviser une spécification avant de coder.

Quand l'éviter

À éviter si le besoin porte uniquement sur l'implémentation dans un framework donné ou sur de l'infrastructure sans contrat d'API.

Analyse de sécurité

Sûr
Score qualité82/100

The skill is a pure instructional document about API design principles. It declares no allowed tools, includes no executable commands, destructive actions, network calls, or data exfiltration. It only provides guidance and references a resource file for further reading, posing no execution risk.

Aucun point d'attention détecté

Exemples

Design a new REST API
Help me design a REST API for a multi-tenant invoicing service. I need resource modeling, error format, pagination, and a versioning strategy.
Review an API spec
Review this OpenAPI spec for consistency and developer friendliness before we implement it, and tell me what to fix.
Migrate from REST to GraphQL
Our team wants to migrate an existing REST API to GraphQL. Walk me through the trade-offs and how to phase the migration.

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. category: Document Processing source: antigravity tags: [api, ai, template, design, document] url: https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-design-principles

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.
Skills similaires