
de atlas-agents433
Directives et liste de vérification pour concevoir des API REST et GraphQL claires, versionnées et optimisées pour les machines, incluant les schémas, les enveloppes d'erreurs et la pagination.
Ce skill propose un processus pratique et optimisé pour concevoir des API REST et GraphQL prévisibles, tant pour les développeurs que pour les agents. Il guide l'utilisateur à travers l'identification des objets de domaine, la structuration des hiérarchies de ressources, la définition des schémas de requête/réponse avec exemples et règles de validation, l'établissement d'une enveloppe d'erreur cohérente, et le choix des stratégies de pagination et de versionnage. L'objectif est d'obtenir des contrats clairs, faciles à consommer, à tester et à faire évoluer.
Utilisez ce skill lorsque vous devez concevoir une nouvelle interface d'API, réviser ou refondre des endpoints existants, rédiger des schémas de requête/réponse pour la documentation ou la génération de code, ou établir des conventions d'équipe (formats d'erreur, pagination, versionnage). Il est approprié lors des revues de conception d'API, du développement "API-first" et lors de la préparation de la documentation pour les développeurs publics.
Ce skill est agnostique quant aux outils, mais il est particulièrement utile pour les assistants de codage et les agents qui génèrent ou révisent des définitions d'API (assistants de code de type Copilot, Codex, Claude Code, Gemini CLI). Il aide les agents à produire des schémas d'API et une documentation cohérents.
Cette compétence n'a pas encore été examinée par notre pipeline d'audit automatisé.