Compétences api-design-principles
🧭
api-design-principles
Sûr 🌐
Accès réseau⚙️
Commandes externes
Concevez des API REST et GraphQL en toute confiance
Les décisions de conception d'API deviennent souvent incohérentes et difficiles à maintenir. Cette compétence fournit des modèles, des patrons et des listes de vérification clairs pour guider vos choix.
Prend en charge: Claude Codex Code(CC)
1
Télécharger le ZIP du skill
2
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
3
Activez et commencez à utiliser
Tester
Utilisation de "api-design-principles". Réviser mes points d'accès utilisateur et commande selon les bonnes pratiques REST.
Résultat attendu:
- Utilisez des noms pluriels : /api/users et /api/orders
- Remplacez les chemins d'action comme /api/createUser par POST /api/users
- Ajoutez la pagination aux points d'accès de liste avec page et page_size
- Retournez 201 Created pour POST réussi et 204 pour DELETE
Utilisation de "api-design-principles". Comment dois-je structurer un schéma GraphQL pour un blog avec des utilisateurs, des articles et des commentaires ?
Résultat attendu:
- Définissez les types User, Post, Comment avec les relations appropriées
- Utilisez la pagination par curseur de style Relay pour les collections
- Créez des types d'entrée pour les mutations avec les charges utiles d'erreurs
- Ajoutez des DataLoaders pour éviter les requêtes N+1 sur les relations
Utilisation de "api-design-principles". Quels codes d'erreur mon API doit-elle retourner pour les erreurs de validation ?
Résultat attendu:
- Retournez 400 Bad Request pour une syntaxe de requête malformée
- Retournez 422 Unprocessable Entity pour les échecs de validation
- Incluez les détails d'erreurs au niveau des champs dans le corps de la réponse
- Utilisez un format d'erreur cohérent pour tous les points d'accès
Audit de sécurité
Sûrv4 • 1/17/2026
This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.
6
Fichiers analysés
2,011
Lignes analysées
2
résultats
4
Total des audits
Facteurs de risque
🌐 Accès réseau (7)
⚙️ Commandes externes (134)
references/graphql-schema-design.md:6-35 references/graphql-schema-design.md:35-40 references/graphql-schema-design.md:40-48 references/graphql-schema-design.md:48-51 references/graphql-schema-design.md:51-72 references/graphql-schema-design.md:72-75 references/graphql-schema-design.md:75-99 references/graphql-schema-design.md:99-102 references/graphql-schema-design.md:102-122 references/graphql-schema-design.md:122-127 references/graphql-schema-design.md:127-171 references/graphql-schema-design.md:171-174 references/graphql-schema-design.md:174-185 references/graphql-schema-design.md:185-190 references/graphql-schema-design.md:190-212 references/graphql-schema-design.md:212-215 references/graphql-schema-design.md:215-231 references/graphql-schema-design.md:231-234 references/graphql-schema-design.md:234-254 references/graphql-schema-design.md:254-259 references/graphql-schema-design.md:259-296 references/graphql-schema-design.md:296-299 references/graphql-schema-design.md:299-314 references/graphql-schema-design.md:314-318 references/graphql-schema-design.md:318-343 references/graphql-schema-design.md:343-347 references/graphql-schema-design.md:347-364 references/graphql-schema-design.md:364-369 references/graphql-schema-design.md:369-388 references/graphql-schema-design.md:388-391 references/graphql-schema-design.md:391-404 references/graphql-schema-design.md:404-409 references/graphql-schema-design.md:409-452 references/graphql-schema-design.md:452-455 references/graphql-schema-design.md:455-474 references/graphql-schema-design.md:474-479 references/graphql-schema-design.md:479-493 references/graphql-schema-design.md:493-496 references/graphql-schema-design.md:496-507 references/graphql-schema-design.md:507-510 references/graphql-schema-design.md:510-520 references/graphql-schema-design.md:520-525 references/graphql-schema-design.md:525-531 references/graphql-schema-design.md:531-534 references/graphql-schema-design.md:534-553 references/graphql-schema-design.md:553-562 references/rest-best-practices.md:6-16 references/rest-best-practices.md:16-19 references/rest-best-practices.md:19-28 references/rest-best-practices.md:28-33 references/rest-best-practices.md:33-37 references/rest-best-practices.md:37-40 references/rest-best-practices.md:40-50 references/rest-best-practices.md:50-53 references/rest-best-practices.md:53-60 references/rest-best-practices.md:60-63 references/rest-best-practices.md:63-68 references/rest-best-practices.md:68-71 references/rest-best-practices.md:71-76 references/rest-best-practices.md:76-81 references/rest-best-practices.md:81-97 references/rest-best-practices.md:97-102 references/rest-best-practices.md:102-113 references/rest-best-practices.md:113-116 references/rest-best-practices.md:116-125 references/rest-best-practices.md:125-128 references/rest-best-practices.md:128-136 references/rest-best-practices.md:136-141 references/rest-best-practices.md:141-147 references/rest-best-practices.md:147-150 references/rest-best-practices.md:150-156 references/rest-best-practices.md:156-159 references/rest-best-practices.md:159-164 references/rest-best-practices.md:164-169 references/rest-best-practices.md:169-177 references/rest-best-practices.md:177-180 references/rest-best-practices.md:180-217 references/rest-best-practices.md:217-222 references/rest-best-practices.md:222-227 references/rest-best-practices.md:227-230 references/rest-best-practices.md:230-232 references/rest-best-practices.md:232-237 references/rest-best-practices.md:237-253 references/rest-best-practices.md:253-256 references/rest-best-practices.md:256-257 references/rest-best-practices.md:257-258 references/rest-best-practices.md:258-259 references/rest-best-practices.md:259-260 references/rest-best-practices.md:260-261 references/rest-best-practices.md:261-262 references/rest-best-practices.md:262-263 references/rest-best-practices.md:263-264 references/rest-best-practices.md:264-265 references/rest-best-practices.md:265-266 references/rest-best-practices.md:266-267 references/rest-best-practices.md:267-272 references/rest-best-practices.md:272-283 references/rest-best-practices.md:283-288 references/rest-best-practices.md:288-304 references/rest-best-practices.md:304-309 references/rest-best-practices.md:309-315 references/rest-best-practices.md:315-319 references/rest-best-practices.md:319-329 references/rest-best-practices.md:329-333 references/rest-best-practices.md:333-362 references/rest-best-practices.md:362-366 references/rest-best-practices.md:366-385 SKILL.md:31 SKILL.md:32 SKILL.md:33 SKILL.md:34 SKILL.md:35 SKILL.md:54-57 SKILL.md:57-60 SKILL.md:60-62 SKILL.md:62-65 SKILL.md:65-67 SKILL.md:67-73 SKILL.md:73-90 SKILL.md:90-94 SKILL.md:94-151 SKILL.md:151-155 SKILL.md:155-212 SKILL.md:212-216 SKILL.md:216-242 SKILL.md:242-248 SKILL.md:248-349 SKILL.md:349-353 SKILL.md:353-442 SKILL.md:442-446 SKILL.md:446-487 SKILL.md:487-492 SKILL.md:492 SKILL.md:492-506
Audité par: claude Voir l’historique des audits →
Score de qualité
55
Architecture
90
Maintenabilité
85
Contenu
21
Communauté
100
Sécurité
87
Conformité aux spécifications
Ce que vous pouvez construire
Définir de nouvelles normes d'API
Créez des règles cohérentes pour REST et GraphQL au sein d'une équipe avant l'implémentation.
Réviser les spécifications d'API
Auditez les spécifications pour le nommage, le versioning et les problèmes de gestion d'erreurs.
Améliorer l'utilisabilité des API
Affinez les points d'accès et le schéma pour réduire la confusion et le travail supplémentaire des clients.
Essayez ces prompts
Révision des bases REST
Examinez ce plan d'API REST et listez les corrections de nommage, de méthodes et de codes d'état. Fournissez un court exemple corrigé.
Vérification du schéma GraphQL
Évaluez ce schéma GraphQL pour la pagination, les types d'entrée et les patrons d'erreurs. Suggérez des améliorations avec de brefs exemples.
Stratégie de versioning
Recommandez une approche de versioning pour cette API et expliquez les compromis. Fournissez une liste de vérification de migration.
Exécution de la liste de vérification
Appliquez une liste de vérification de conception d'API à cette spécification et renvoyez réussi ou échoué avec les corrections pour chaque élément échoué.
Bonnes pratiques
- Documentez les règles de versioning et de dépréciation avant le lancement
- Utilisez des formats d'erreur cohérents avec des codes d'erreur stables
- Paginez tous les points d'accès de collection avec des limites claires
Éviter
- Utiliser POST pour les opérations en lecture seule
- Chemins de ressources imbriqués au-delà de deux niveaux
- Retourner des formes d'erreur incohérentes entre les points d'accès
Foire aux questions
Est-ce compatible avec Claude, Codex et Claude Code ?
Oui. Les conseils sont indépendants de la plateforme et fonctionnent avec Claude, Codex et Claude Code.
Quelles sont les limites de cette compétence ?
Elle fournit des patrons et des modèles mais ne génère pas un service d'API complet fonctionnel.
Puis-je intégrer cela avec ma base de code existante ?
Oui. Utilisez la liste de vérification et les modèles pour aligner vos points d'accès et schéma existants.
Accède-t-elle ou stocke-t-elle des données sensibles ?
Non. Elle fournit uniquement des conseils et des exemples statiques.
Que faire si ma conception d'API n'est pas couverte ?
Fournissez votre spécification et vos objectifs, puis demandez des recommandations ciblées.
Comment cela se compare-t-il aux conseils génériques sur les API ?
Elle inclut des patrons concrets REST et GraphQL avec des listes de vérification et des modèles.