Concevoir une API REST complète
Concevez une API REST robuste et bien structurée avec documentation OpenAPI, gestion des erreurs et bonnes pratiques de sécurité.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un architecte API senior spécialisé dans la conception d'APIs RESTful. Je dois concevoir une API pour [DESCRIPTION_DU_SYSTÈME] qui sera utilisée par [TYPE_DE_CLIENTS: ex. applications mobiles, partenaires tiers, frontend React]. **Ressources principales à gérer :** [LISTER_LES_RESSOURCES: ex. Utilisateurs, Produits, Commandes, Paiements] **Contraintes techniques :** - Backend : [EX: Node.js/Express, Python/FastAPI, Go] - Authentification : [EX: JWT, OAuth2, API Key] - Volume estimé : [EX: 10 000 requêtes/jour] - Versions à supporter : [EX: v1 uniquement, ou v1 + v2] Conçois une API REST complète en couvrant : 1. **Structure des endpoints** : liste tous les endpoints CRUD pour chaque ressource avec leur méthode HTTP, chemin, paramètres et codes de réponse. 2. **Authentification et autorisation** : détaille le flux d'authentification et les règles de permission par endpoint. 3. **Conventions de nommage** : définis les règles de nommage pour les ressources, paramètres et réponses. 4. **Gestion des erreurs** : propose un format de réponse d'erreur standardisé avec des codes d'erreur métier. 5. **Pagination et filtrage** : définis la stratégie de pagination et les paramètres de filtrage/tri. 6. **Documentation OpenAPI** : génère le fichier swagger.yaml pour les 3 endpoints les plus importants. 7. **Bonnes pratiques de sécurité** : rate limiting, validation des entrées, CORS, headers de sécurité.
Pourquoi ce prompt fonctionne
<p>Ce prompt guide l'IA à travers toutes les décisions architecturales d'une API REST professionnelle. En spécifiant les ressources et les contraintes dès le début, on obtient une conception cohérente et réaliste plutôt qu'un exemple générique.</p><p>La demande d'un fichier OpenAPI partiel est particulièrement précieuse car elle force la concrétisation des décisions conceptuelles en une spécification exécutable que les équipes frontend et backend peuvent utiliser immédiatement.</p><p>L'inclusion des aspects sécurité (rate limiting, CORS, headers) dans la conception initiale plutôt qu'en afterthought reflète les meilleures pratiques de Security by Design, réduisant les risques de vulnérabilités introduites lors d'ajouts tardifs.</p>
Cas d'usage
Résultat attendu
Une spécification complète d'API avec endpoints, flux d'authentification, format d'erreurs, stratégie de pagination et extrait OpenAPI.
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
Prompt pour optimiser vos requêtes SQL et booster les performances
Un prompt complet pour analyser, diagnostiquer et optimiser vos requêtes SQL avec des recommandations d'indexation et de réécriture adaptées à votre moteur de base de données.
Prompt pour débugger votre code Python avec ChatGPT
Un prompt structuré pour obtenir une analyse complète de vos bugs Python : identification, explication de la cause racine, correction commentée et conseils de prévention.
Prompt pour écrire des scripts Bash professionnels et robustes
Un prompt complet pour générer des scripts Bash robustes et professionnels, avec gestion d'erreurs, parsing d'arguments et bonnes pratiques intégrées.
É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.