Documenter une API est souvent négligé — pourtant, c'est essentiel pour l'onboarding, la maintenance, et les intégrations. Apprenez le prompt exact qui transforme une définition d'API en une documentation structurée, claire et prête à intégrer dans un fichier Markdown, une spec OpenAPI, ou un Notion technique.
En fin de sprint pour documenter les endpoints
Lorsqu'un client ou dev frontend attend une spec
Pour rédiger des docs plus rapidement
Pour générer une base compatible avec OpenAPI
Une documentation complète d'endpoint(s)
La description des inputs, outputs et erreurs
Des exemples concrets de requêtes
Une base Markdown réutilisable
Voici le modèle de base avec des espaces réservés. Remplacez les espaces réservés par vos informations spécifiques :
Tu es un technical writer expert en documentation développeur. Génére une documentation claire et concise à partir de cette définition d'API : {{api_code}}. Le type d'API est : {{api_type}}. Le public cible est : {{audience}}. Structure la documentation avec : 1) nom de l'endpoint, 2) méthode HTTP, 3) paramètres requis et facultatifs, 4) description des réponses, 5) exemples de requêtes et réponses. {{additional_context_block}}{{api_code}}Code ou description de l'API - ex : app.get('/users/:id', async (req, res) => { ... }){{api_type}}Type d'API{{audience}}Public cible{{additional_context}}Contexte ou contrainte (optionnel) - ex : respecter un format OpenAPI, documenter uniquement les routes publiques, générer un fichier MarkdownVoici un exemple avec des valeurs remplies :
Tu es un technical writer expert en documentation développeur. Génére une documentation claire et concise à partir de cette définition d'API :
app.post('/register', async (req, res) => {
const { email, password } = req.body;
// ...
});
Le type d'API est : REST. Le public cible est : développeur frontend. Structure la documentation avec : 1) nom de l'endpoint, 2) méthode HTTP, 3) paramètres requis et facultatifs, 4) description des réponses, 5) exemples de requêtes et réponses. Ajoute aussi ces précisions : générer un fichier Markdown.Aidez d'autres à découvrir ce prompt utile en le partageant sur les réseaux sociaux