Prompt pour créer une API REST complète de A à Z
Un prompt complet pour générer une API REST professionnelle avec authentification, validation, documentation et tests intégrés.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un développeur backend senior spécialisé en conception d'API REST. Crée une API REST complète pour [DESCRIPTION DU PROJET] en utilisant [LANGAGE/FRAMEWORK] avec les spécifications suivantes : 1. **Architecture** : Structure le projet selon les bonnes pratiques (controllers, services, repositories, middlewares). Fournis l'arborescence complète des fichiers. 2. **Modèles de données** : Définis les entités principales avec leurs relations (one-to-many, many-to-many). Inclus les schémas de base de données avec les types de champs, contraintes et index. 3. **Endpoints CRUD** : Pour chaque ressource, implémente : - GET (liste paginée avec filtres et tri) - GET by ID (avec relations imbriquées) - POST (avec validation des données entrantes) - PUT/PATCH (mise à jour partielle et complète) - DELETE (soft delete si pertinent) 4. **Authentification & Autorisation** : Implémente JWT avec refresh tokens, middleware d'authentification, et gestion des rôles (admin, utilisateur, lecture seule). 5. **Validation & Gestion d'erreurs** : Crée un système centralisé de validation des entrées et un handler d'erreurs global retournant des réponses JSON cohérentes avec codes HTTP appropriés. 6. **Middleware** : Ajoute rate limiting, CORS, logging des requêtes, et compression des réponses. 7. **Documentation** : Génère une documentation Swagger/OpenAPI pour chaque endpoint avec exemples de requêtes et réponses. 8. **Tests** : Écris des tests unitaires pour les services et des tests d'intégration pour les endpoints principaux. Pour chaque fichier, fournis le code complet et commenté. Commence par le setup du projet, puis implémente chaque couche progressivement.
Pourquoi ce prompt fonctionne
<p>Ce prompt guide l'IA pour produire une API REST de qualité production en couvrant toutes les couches essentielles. En précisant <strong>[DESCRIPTION DU PROJET]</strong> (ex : "une plateforme de gestion de tâches collaboratives") et <strong>[LANGAGE/FRAMEWORK]</strong> (ex : "Node.js avec Express" ou "Python avec FastAPI"), vous obtenez un code adapté à votre contexte exact.</p><p>La structure en 8 points force l'IA à ne rien oublier : de l'architecture des fichiers jusqu'aux tests, en passant par la sécurité et la documentation. Chaque section est suffisamment détaillée pour éviter les réponses superficielles, tout en laissant l'IA adapter les patterns à votre stack technique.</p><p><strong>Conseil d'utilisation</strong> : pour les projets complexes, soumettez d'abord le prompt complet pour obtenir l'architecture globale, puis demandez l'implémentation détaillée section par section. Vous pouvez aussi ajouter des contraintes spécifiques comme <ul><li>Une base de données particulière (PostgreSQL, MongoDB)</li><li>Un hébergement cible (Docker, serverless)</li><li>Des exigences de performance (cache Redis, pagination cursor-based)</li></ul></p>
Cas d'usage
Résultat attendu
Un projet API REST complet avec arborescence de fichiers, code source commenté pour chaque couche (routes, controllers, services, modèles), configuration d'authentification JWT, middleware de validation, documentation Swagger et exemples de tests unitaires et d'intégration.
Formez-vous en profondeur
Découvrez le skill complet sur Prompt Guide pour maîtriser cette technique de A à Z.
Voir sur Prompt GuideTermes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Prompts similaires
Écrire des tests unitaires complets
Générez une suite de tests unitaires exhaustive couvrant les cas nominaux, les cas limites et les erreurs avec des mocks appropriés.
Générez une documentation technique complète pour votre code
Un prompt complet pour générer de la documentation technique structurée et professionnelle, adaptée au public cible et au type de projet.
Créer un outil CLI avec Node.js
Créez un outil CLI Node.js professionnel avec Commander.js, Inquirer, feedback visuel et publication npm.
Automatisez vos commits Git avec l'IA : le prompt ultime
Ce prompt analyse un diff Git et génère automatiquement des messages de commit structurés selon les conventions du projet, avec découpage atomique si nécessaire.