API Design Patterns

38 règles pour la dénomination des endpoints REST, les erreurs, la pagination, le versioning et la sécurité des API.

par AsyrafHussin · AsyrafHussin/agent-skills

Testé · Fonctionne ★ 9.6/10

API Design Patterns — 38 règles pour la dénomination des endpoints REST, les erreurs, la pagination, le versioning et la sécurité des API.

Ce que fait

Un recueil de règles condensé (38 règles / 7 catégories) pour la conception d'API RESTful, couvrant la dénomination des ressources, la forme des réponses d'erreur, la pagination, le versioning et l'authentification. Se déclenche lors de la conception ou de la révision des endpoints, ou de l'écriture de code de gestion des erreurs/pagination, et renvoie aux fichiers par règle (rules/*.md) et à un AGENTS.md compilé de 7 200 lignes pour des approfondissements.

Rapport de test

Exécuté une refonte réelle de l''API des factures' à travers elle : la compétence a transformé les URL basées sur des verbes (POST /createInvoice) en noms propres, remplacé une simple chaîne d'erreur par une enveloppe structurée (code/message/details/request_id), et ajouté des métadonnées de pagination par curseur ainsi que des liens HATEOAS que la base de référence naïve n'avait jamais eus.

Testé le: 2026-07-14 · Claude Code 2.x (agent harness)

Installation

git clone https://github.com/AsyrafHussin/agent-skills
cd agent-skills
mkdir -p ~/.claude/skills
cp -r skills/api-design-patterns ~/.claude/skills/api-design-patterns

Commandes et exemples de prompts

  • /api-design-patterns38 règles pour la dénomination des endpoints REST, les erreurs, la pagination, le versioning et la sécurité des API.

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

  • Design a REST API for user management with proper error handling
  • Review my API endpoints for best practices before we ship
  • What HTTP status codes should I use for this validation error?