Cette compétence fournit des conseils complets pour concevoir des API RESTful et GraphQL selon les meilleures pratiques de l'industrie. Elle aide les développeurs à créer des API bien structurées, versionnées et documentées.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "api-design". Concevoir une API REST pour un blog avec des articles et des commentaires
Résultat attendu:
Endpoints: GET/POST /api/v1/posts, GET/PUT/DELETE /api/v1/posts/{id}, GET/POST /api/v1/posts/{id}/comments, Response codes: 200, 201, 204, 400, 401, 403, 404
Utilisation de "api-design". Créer une spécification OpenAPI pour la gestion des utilisateurs
Résultat attendu:
OpenAPI 3.0 avec point de terminaison /users, GET (liste des utilisateurs avec pagination), POST (créer un utilisateur), authentification JWT Bearer, réponses 200/201 avec schéma User
Audit de sécurité
SûrAll 76 static findings are false positives. The skill is pure documentation providing API design guidance. The scanner detected backtick formatting in markdown examples, legitimate documentation URLs, and JWT authentication references - none of which constitute security risks.
Motifs détectés
Score de qualité
Ce que vous pouvez construire
Nouveau développement d'API
À utiliser lors du démarrage d'un nouveau projet d'API pour établir les conventions appropriées, la dénomination des ressources et la structure des points de terminaison dès le début
Documentation d'API
Générer des spécifications OpenAPI et de la documentation pour les API existantes ou nouvelles afin de les partager avec les équipes frontend et les consommateurs externes
Révision et refactorisation d'API
Réviser les conceptions d'API existantes selon les meilleures pratiques et identifier les domaines d'amélioration dans la dénomination, le versionnement et la structure
Essayez ces prompts
Concevoir une API REST pour une ressource [nom de la ressource]. Inclure les définitions des points de terminaison, les méthodes HTTP, les codes de réponse et les formats de requête/réponse.
Concevoir une API REST avec ces ressources : [liste des ressources] et leurs relations. Inclure les ressources imbriquées et la structure URL appropriée.
Générer une spécification OpenAPI 3.0 pour une API qui a ces points de terminaison : [liste des points de terminaison]. Inclure les schémas de requête/réponse, les paramètres et l'authentification.
Concevoir un schéma GraphQL pour [cas d'utilisation]. Inclure les définitions de types, les requêtes, les mutations et les résolveurs appropriés.
Bonnes pratiques
- Utiliser une dénomination cohérente des ressources avec des noms, pas de verbes, et des formes plurielles
- Versionner les API dès le début en utilisant le versionnement par chemin URL (ex: /api/v1/)
- Implémenter une gestion des erreurs appropriée avec un format de réponse d'erreur cohérent incluant les codes d'erreur et les détails
Éviter
- Utiliser des verbes dans les noms des points de terminaison (ex: /getUsers au lieu de /users)
- Ne pas versionner les API, casser les clients lorsque des changements sont nécessaires
- Retourner différents formats d'erreur à travers les points de terminaison
Foire aux questions
Quelle est la différence entre PUT et PATCH ?
Quand dois-je utiliser GraphQL au lieu de REST ?
Comment dois-je versionner mon API ?
Quels codes de statut HTTP dois-je utiliser ?
Comment gérer la pagination ?
Quelles méthodes d'authentification cette compétence couvre-t-elle ?
Détails du développeur
Structure de fichiers
📄 SKILL.md