Concevoir une API REST selon les meilleures pratiques
Guide la conception d'une API REST complète et bien structurée, de la définition des endpoints à la documentation OpenAPI, en suivant les standards de l'industrie.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un expert en conception d'APIs REST. Aide-moi à concevoir une API complète pour le besoin suivant.
Ressource / Domaine métier : [DOMAINE_METIER] (ex: gestion des commandes e-commerce)
Utilisateurs de l'API : [UTILISATEURS_API] (ex: application mobile, partenaires B2B)
Authentification souhaitée : [TYPE_AUTH] (JWT, OAuth2, API Key...)
Conçois l'API en couvrant :
- Liste des endpoints avec verbes HTTP, URLs et descriptions
- Conventions de nommage et structure des URLs
- Schémas de requête et réponse (format JSON avec exemples)
- Codes HTTP retournés par endpoint et leur signification
- Gestion des erreurs (format standard, codes d'erreur métier)
- Stratégie de versioning (v1, v2...)
- Pagination, filtrage et tri pour les listes
- Rate limiting recommandé
- Exemple OpenAPI/Swagger pour 2 endpoints clés
- Liste des pièges REST courants à éviter
Personnaliser ce prompt avec Léa
Réponds à 3 questions, Léa adapte le prompt à ta situation.
Pourquoi ce prompt fonctionne
Le prompt couvre toutes les dimensions d'une API de qualité production. La demande d'exemples JSON concrets évite les réponses trop abstraites. L'inclusion des pièges courants à éviter produit une liste de contrôle qualité intégrée au livrable.
Cas d'usage
Résultat attendu
Spécification API complète avec liste des endpoints, schémas JSON, codes d'erreur, exemple OpenAPI et liste des anti-patterns à éviter.
Améliorez ce prompt
Passez ce prompt dans l'Optimiseur pour renforcer le contexte, les contraintes et le format attendu.
Améliore ce prompt avec l'OptimiseurCommentaires
- LéaIA
Pour un résultat optimal, remplace chaque [PLACEHOLDER] par un cas métier réel (ex: commandes e-commerce) et précise les contraintes de charge. Ainsi l’IA pourra adapter pagination, rate limiting et choix d’authentification à ton contexte.
Termes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Exercices pour pratiquer
Evaluation et red-teaming
Testez la robustesse d'un chatbot IA avec des techniques de red-teaming.
Mega-prompt
Creez un mega-prompt complet pour un assistant IA specialise.
Generation de code
Generez du code production-ready avec des prompts structures.