Générer la documentation technique d'une API
Génère une documentation technique complète et orientée développeur pour une API, incluant guide de démarrage rapide, référence des endpoints et tableau des erreurs.
Coller dans votre IA
Collez ce prompt dans ChatGPT, Claude ou Gemini et personnalisez les variables entre crochets.
Tu es un technical writer spécialisé en documentation d'APIs. Génère une documentation complète et orientée développeur pour l'API suivante.
Nom du produit / API : [NOM_API]
Public cible : [PUBLIC_CIBLE] (développeurs débutants, expérimentés, intégrateurs B2B...)
Langage des exemples : [LANGAGE_EXEMPLES] (JavaScript, Python, curl...)
Description des endpoints (ou code source) :
[DESCRIPTION_ENDPOINTS]
Génère la documentation avec :
- Introduction : à quoi sert l'API, cas d'usage principaux
- Authentification : comment s'authentifier avec exemple complet
- Guide de démarrage rapide (Quick Start en 5 minutes)
- Référence des endpoints : pour chaque endpoint, méthode, URL, paramètres, réponse exemple, erreurs possibles
- Codes d'erreur : tableau complet avec signification et action recommandée
- Limites et quotas (rate limiting)
- Changelog (section vide à remplir)
Ton : professionnel, concis, orienté action. Utilise Markdown.
Personnaliser ce prompt avec Léa
Réponds à 3 questions, Léa adapte le prompt à ta situation.
Pourquoi ce prompt fonctionne
Le ton et le public cible sont explicitement définis pour adapter le niveau de détail. La demande de Markdown assure une sortie immédiatement publiable. Le guide de démarrage rapide est prioritaire car c'est ce que les développeurs lisent en premier pour évaluer une API.
Cas d'usage
Résultat attendu
Documentation Markdown complète avec introduction, guide de démarrage, référence des endpoints avec exemples de code, tableau d'erreurs et section changelog.
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 "Authentification" un exemple de flux d'erreur (token expiré, refresh) avec la réponse HTTP réelle. Les développeurs gagneront du temps en débuguant.
Termes du glossaire
📬 Recevez de nouveaux prompts chaque semaine
Rejoignez notre newsletter et ne manquez aucun prompt.
Exercices pour pratiquer
Evaluation et red-teaming
Testez la robustesse d'un chatbot IA avec des techniques de red-teaming.
Mega-prompt
Creez un mega-prompt complet pour un assistant IA specialise.
Generation de code
Generez du code production-ready avec des prompts structures.