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 :
- Structure des endpoints : liste tous les endpoints CRUD pour chaque ressource avec leur méthode HTTP, chemin, paramètres et codes de réponse.
- Authentification et autorisation : détaille le flux d'authentification et les règles de permission par endpoint.
- Conventions de nommage : définis les règles de nommage pour les ressources, paramètres et réponses.
- Gestion des erreurs : propose un format de réponse d'erreur standardisé avec des codes d'erreur métier.
- Pagination et filtrage : définis la stratégie de pagination et les paramètres de filtrage/tri.
- Documentation OpenAPI : génère le fichier swagger.yaml pour les 3 endpoints les plus importants.
- Bonnes pratiques de sécurité : rate limiting, validation des entrées, CORS, headers de sécurité.
Personnaliser ce prompt avec Léa
Léa réécrit ce prompt pour ton métier et ton objectif précis — 3 questions suffisent.
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.
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
Ajoutez dans la section "Contraintes techniques" le format des données (JSON, XML) et une durée de validité des tokens. Ça évitera des réponses trop génériques et vous obtiendrez des flux d'authentification plus précis, avec des politiques de rafraîchissement réutilisables.
Termes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Pour aller plus loin
Prompts similaires
Mise en œuvre de la CSP avec des nonces
Prévenir les XSS avec une CSP stricte
Déboguer une erreur en production
Analysez rapidement une erreur de production avec une approche structurée de Root Cause Analysis et un plan d'action immédiat.
Implémenter l'authentification JWT
Ajouter l'authentification JWT à une API
Prompt GitHub Copilot pour générer du code JavaScript
GitHub Copilot, l'assistant de programmation basé sur l'intelligence artificielle développé par GitHub et OpenAI, a transformé la manière dont les développeurs écrivent du code JavaScript. En s'appuyant sur des milliards de lignes de code open source, Copilot est capable de générer des fonctions complètes, des classes, des modules et même des architectures entières à partir de simples descriptions en langage naturel. Pour tirer le meilleur parti de cet outil, il est essentiel de maîtriser l'art du prompt engineering appliqué à la génération de code. Un prompt bien structuré permet d'obtenir du code JavaScript propre, performant et conforme aux bonnes pratiques modernes (ES2024+, typage implicite, gestion d'erreurs, modularité). Dans ce guide, nous vous proposons des prompts optimisés pour GitHub Copilot qui vous permettront de générer du code JavaScript de qualité professionnelle, que vous développiez une API REST, un composant frontend, un script utilitaire ou une logique métier complexe. Chaque prompt a été conçu pour fournir suffisamment de contexte à Copilot tout en laissant la flexibilité nécessaire à une génération pertinente et adaptée à votre projet.