Rédiger une documentation API
Génération automatique de documentation API
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Génère une documentation OpenAPI 3.0 pour les routes API suivantes : [COLLER_DÉFINITIONS_ROUTES]. Inclus les schémas de requête/réponse avec des exemples, les exigences d'authentification, les réponses d'erreur et des descriptions en markdown pour chaque point de terminaison. Sortie en YAML valide.
Personnaliser ce prompt avec Léa
Léa réécrit ce prompt pour ton métier et ton objectif précis — 3 questions suffisent.
Cas d'usage
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 des schémas plus réalistes, ajoutez des exemples concrets de données dans chaque définition de route. Précisez aussi le type d'authentification (Bearer, OAuth2, API Key) avec les scopes si nécessaire. Variante utile : demandez l'inclusion des contraintes de validation (minimum, maximum, pattern) pour chaque champ.
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
Planifier une migration d’un monolithe vers des microservices
Migrer des monolithes de façon incrémentielle
Créer un système de cache Redis performant et scalable
Un prompt complet pour concevoir et implémenter un système de cache Redis avec stratégies d'invalidation, gestion des erreurs et monitoring.
Prompt pour créer des Serverless Functions optimisées
Prompt complet pour concevoir des serverless functions production-ready sur Vercel ou AWS Lambda, couvrant le code, la sécurité, les performances et le déploiement.