DocGen – Générateur de documentation d’APIs Gemini pour VS Code
Extension VS Code pour générer automatiquement de la documentation d’APIs grâce à Gemini AI. La documentation est créée dans le dossier docs/ du projet, avec un nom de fichier parlant selon l’API détectée.
🚀 Fonctionnalités principales
Génération automatique de documentation pour les APIs uniquement (routes, endpoints, contrôleurs, etc.)
Détection automatique du type d’API dans la sélection
Création d’un fichier Markdown dans le dossier docs/ avec un nom explicite (ex : doc_getUser.md, doc_route_post_api_login.md)
Choix de la langue : Français ou Anglais
Utilisation simple via une seule commande
🛠️ Installation
Téléchargez ou clonez ce dépôt :
git clone https://github.com/Tiavina22/docgen.git
Installez les dépendances :
npm install
Compilez l’extension :
npm run compile
Ouvrez le dossier dans VS Code et appuyez sur F5 pour lancer en mode développement.
🔑 Configuration de la clé API Gemini
L’extension nécessite une clé API Gemini valide pour fonctionner.
Rendez-vous dans les paramètres de VS Code (Ctrl+, ou Cmd+,)
Cherchez Gemini DocGen
Renseignez votre clé API dans le champ "geminiDocgen.apiKey"
Vous pouvez aussi cliquer sur le bouton "Configurer la clé API" dans la sidebar de l’extension.
⚠️ Sans clé API, la génération sera désactivée et un message d’avertissement s’affichera.
✨ Utilisation rapide
Sélectionnez le code d’une API (route, endpoint, contrôleur, etc.) dans l’éditeur
Lancez la commande Générer documentation avec Gemini (Ctrl+Shift+P puis tapez le nom de la commande)
Un fichier Markdown est créé automatiquement dans le dossier docs/ avec la documentation générée
Le fichier s’ouvre automatiquement
Si la sélection ne correspond pas à une API, aucun fichier n’est généré et un message d’avertissement s’affiche
� Exemple de résultat
Après génération, un fichier comme docs/doc_getUser.md ou docs/doc_route_post_api_login.md sera créé avec la documentation de l’API sélectionnée.
⚙️ Paramètres disponibles
Paramètre
Description
Valeurs possibles
geminiDocgen.apiKey
Clé API Gemini
(string)
geminiDocgen.language
Langue de la documentation générée
fr, en
❓ FAQ
Q : Où trouver ma clé API Gemini ?
A : Sur le site officiel de Gemini (Google AI), dans votre espace développeur.
Q : L’extension ne génère rien, que faire ?
A : Vérifiez que la clé API est bien renseignée dans les paramètres et que la sélection correspond à une API (route, endpoint, contrôleur, etc.).
