Anmolop97/Agent-Skills

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

Qu'est-ce que Agent-Skills ?

Cette compétence vous guide à travers les principes fondamentaux de conception d'API REST et GraphQL, vous aidant à créer des API intuitives, évolutives et maintenables. Elle est particulièrement utile lors de la conception de nouvelles API, de la révision de spécifications, de l'établissement de normes de conception pour votre équipe ou de la migration entre paradigmes d'API. Basée sur un guide structuré, elle vous accompagne de la définition des consommateurs et cas d'utilisation jusqu'à la spécification des erreurs, du versioning, de la pagination et des stratégies d'authentification. La compétence inclut également des références à des ressources détaillées, comme un playbook de mise en œuvre, pour des modèles et des listes de contrôle approfondies. Elle est conçue pour être utilisée avec des agents d'IA comme Claude Code, Cursor ou Codex, et met l'accent sur une validation rigoureuse avec des exemples pour garantir la cohérence.

Compatible avec~Claude Code~Codex CLI~Cursor

npx skills add https://github.com/Anmolop97/Agent-Skills/tree/HEAD/skills/api-design-principles

Documentation

Principes de conception d'API

Maîtrisez les principes de conception d'API REST et GraphQL pour créer des API intuitives, évolutives et maintenables qui raviront les développeurs et résisteront à l'épreuve du temps.

Utilisez cette compétence lorsque

Vous concevez une nouvelle API REST ou GraphQL
Vous refactorez une API existante pour améliorer son utilisabilité
Vous établissez des normes de conception d'API pour votre équipe
Vous révisez des spécifications d'API avant leur mise en œuvre
Vous migrez entre paradigmes d'API (REST vers GraphQL, etc.)
Vous créez une documentation d'API orientée développeur
Vous optimisez des API pour des cas d'utilisation spécifiques (mobile, intégrations tierces)

N'utilisez pas cette compétence lorsque

Vous avez seulement besoin de conseils de mise en œuvre pour un framework spécifique
Vous effectuez un travail purement d'infrastructure sans contrats d'API
Vous ne pouvez pas modifier ou versionner des interfaces publiques

Instructions

Définissez les consommateurs, cas d'utilisation et contraintes.
Choisissez le style d'API et modélisez les ressources ou types.
Spécifiez les erreurs, le versioning, la pagination et la stratégie d'authentification.
Validez avec des exemples et révisez pour garantir la cohérence.

Consultez resources/implementation-playbook.md pour des modèles détaillés, des listes de contrôle et des gabarits.

Ressources

resources/implementation-playbook.md pour des modèles détaillés, des listes de contrôle et des gabarits.