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
Prompts similaires
Apprendre les bases de Git pour débutants
Apprenez Git de zéro avec des explications imagées, des exemples concrets, un workflow pratique et un cheatsheet des commandes essentielles.
Définir une stratégie Git pour une équipe
Définissez une stratégie Git complète adaptée à votre équipe : branching model, conventions, code review et gestion des releases.
Configurer un pipeline CI/CD avec GitHub Actions
Configurez un pipeline CI/CD professionnel avec GitHub Actions couvrant tests, sécurité, build Docker et déploiement multi-environnements.
Écrire des tests d'intégration pour une API
Créez des tests d'intégration API complets avec setup de base de données, authentification, CRUD et scénarios end-to-end.