📦

api-patterns

Name: api-patterns
Author: sickn33

آمن

Concevoir de meilleures API avec un guide de conception

La construction d'API sans principes de conception clairs conduit à des interfaces incohérentes et une mauvaise expérience développeur. Cette compétence fournit des arbres de décision et les meilleures pratiques pour choisir le bon style d'API et l'implémenter correctement.

يدعم: Claude Codex Code(CC)

🥉 75 برونزي

تنزيل ZIP المهارة

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

فعّل وابدأ الاستخدام

اختبرها

استخدام "api-patterns". Should I use REST or GraphQL for a mobile app with complex data relationships?

النتيجة المتوقعة:

GraphQL est mieux adapté à votre cas d'utilisation car: 1) Les applications mobiles bénéficient de requêtes flexibles pour réduire le sur-chargement, 2) Plusieurs plateformes frontend peuvent demander exactement ce dont elles ont besoin, 3) Les graphes de données complexes correspondent naturellement au schéma GraphQL. Cependant, considérez GraphQL si votre équipe est familiarisée et que vous avez l'infrastructure pour l'analyse du coût des requêtes.

استخدام "api-patterns". What HTTP status codes should I use for a POST endpoint that creates a user?

النتيجة المتوقعة:

Utilisez 201 Created pour la création réussie d'utilisateur, 400 Bad Request pour une entrée invalide, 409 Conflict si l'email existe déjà, et 500 pour les erreurs serveur. Incluez l'utilisateur créé dans le corps de la réponse et définissez l'en-tête Location vers l'URI de la nouvelle ressource.

التدقيق الأمني

آمن

v1 • 2/24/2026

All 67 static findings are false positives. The skill is a documentation resource for API design patterns. Backticks detected are markdown code formatting, not shell commands. No weak cryptography or reconnaissance tools present.

الملفات التي تم فحصها

735

الأسطر التي تم تحليلها

النتائج

إجمالي عمليات التدقيق

مشكلات متوسطة المخاطر (1)

api-style.md:7-24 graphql.md:7-41 trpc.md:7-41 rest.md:7-14

Markdown Code Blocks Flagged as Shell Commands

Static analyzer detected backticks in markdown files and flagged them as 'Ruby/shell backtick execution'. These are documentation code blocks for API decision trees and examples, not actual shell commands.

مشكلات منخفضة المخاطر (1)

rest.md:34-38 security-testing.md:59 security-testing.md:102

HTTP Status Code Terms Flagged as Reconnaissance

Security testing documentation mentions standard HTTP status codes (401 Unauthorized, 403 Forbidden) and SSRF testing concepts. These are legitimate API security education topics, not reconnaissance tools.

تم تدقيقه بواسطة: claude

درجة الجودة

الهندسة المعمارية

100

قابلية الصيانة

المحتوى

المجتمع

الأمان

الامتثال للمواصفات

ماذا يمكنك بناءه

Choisir l'architecture d'API

Développeur démarrant un nouveau projet et devant décider entre REST, GraphQL ou tRPC en fonction de sa pile frontend et de la complexité des données.

Concevoir des points de terminaison REST

Équipe implémentant une API REST et ayant besoin de conseils sur le nommage des ressources, les méthodes HTTP et l'utilisation correcta des codes de statut.

Revue de sécurité d'API

Ingénieur de sécurité auditant les API existantes pour les vulnérabilités courantes en utilisant la liste de contrôle OWASP API Top 10.

جرّب هذه الموجهات

Sélection du style d'API

Je construis un [décrivez votre projet, ex: application e-commerce avec frontend React et backend Node.js]. Quel style d'API devrais-je utiliser? Quels sont les compromis?

Conception de points de terminaison REST

Je dois concevoir des points de terminaison REST pour [décrivez la ressource, ex: gestion d'utilisateurs avec profils, posts et commentaires]. Montrez-moi la structure d'URL appropriée, les méthodes HTTP et les codes de statut.

Gestion des erreurs d'API

Quelle est la meilleure façon de gérer les erreurs dans mon API? Montrez-moi le format de réponse approprié et les codes d'état HTTP à utiliser pour [listez les scénarios d'erreur].

Stratégie de versioning d'API

Comment devrais-je versionner mon API? Je prévois que l'API évolue avec le temps. Comparez le versioning URI, le versioning par en-têtes et le versioning par paramètres de requête.

أفضل الممارسات

Choisissez le style d'API en fonction des besoins du client, et non des préférences personnelles - considérez la pile frontend, la complexité des données et les exigences de mise en cache
Utilisez des enveloppes de réponse cohérentes et des formats d'erreur standardisés pour tous les points de terminaison
Implémentez la limitation de débit dès le début et communiquez clairement les limites dans la documentation de l'API

تجنب

Utiliser des verbes dans les points de terminaison REST (ex: /getUsers au lieu de GET /users)
Retourner différents formats de réponse pour la même ressource via différents points de terminaison
Exposer les messages d'erreur internes et les traces de pile aux clients API

الأسئلة المتكررة

Quand dois-je choisir REST plutôt que GraphQL?

Choisissez REST pour les API publiques nécessitant une large compatibilité, des opérations CRUD simples, ou lorsque la mise en cache HTTP est importante. Choisissez GraphQL pour les relations de données complexes, plusieurs plateformes frontend, ou lorsque les clients ont besoin de requêtes flexibles.

Quelle est la meilleure stratégie de versioning d'API?

Le versioning URI (ex: /v1/users) est le plus courant et visible. Le versioning par en-têtes est plus propre mais moins découvrable. Le versioning par requête (ex: /users?version=1) fonctionne pour les petits changements mais peut surcharger les URLs.

Comment dois-je gérer la pagination dans mon API?

Utilisez la pagination par curseur pour les grands ensembles de données et le défilement infini. Utilisez la pagination par décalage pour les tailles de page connues. Incluez le nombre total lorsqu'utile et fournissez des liens suivant/précédent dans la réponse.

Quelle est la différence entre les codes de statut 401 et 403?

401 Unauthorized signifie que l'authentification est manquante ou invalide. 403 Forbidden signifie que l'authentification est valide mais que l'utilisateur n'a pas la permission pour la ressource demandée.

Devrais-je utiliser JWT ou l'authentification basée sur les sessions?

JWT est meilleur pour les API sans état et les microservices. L'auth basée sur les sessions fonctionne bien pour les applications traditionnelles rendues par le serveur. Considérez vos besoins de mise à l'échelle et les types de clients.

Comment protéger mon API contre les attaques courantes?

Implémentez la limitation de débit, validez toutes les entrées, utilisez des requêtes paramétrées, implémentez des vérifications d'autorisation appropriées (BOLA), désactivez l'introspection en production et suivez les directives OWASP API Top 10.