💻 Développement

api-doc-generator

Génère une documentation d'API claire et structurée à partir de code, routes ou descriptions.

⚡ Installation & lancement en 1 commande

Copiez-collez dans votre terminal : le skill s'installe dans ~/.claude/skills et Claude Code se lance directement dessus.

macOS / Linux
curl -fsSL https://raw.githubusercontent.com/khalilbenaz/claude-skills-collection/main/install.sh | sh -s -- api-doc-generator --launch
Windows (PowerShell)
iex "& { $(iwr -useb https://raw.githubusercontent.com/khalilbenaz/claude-skills-collection/main/install.ps1) } api-doc-generator -Launch"

🚀 Déjà installé ?

claude "/api-doc-generator"

Ou tapez /api-doc-generator dans une session Claude Code, ou décrivez simplement votre besoin — le skill se déclenche automatiquement via le skill-router.

🔑 Déclencheurs automatiques

Le skill s'active automatiquement quand votre demande contient :

documente mon APIswaggerendpoint documentationAPI docs

📦 Installation manuelle

git clone https://github.com/khalilbenaz/claude-skills-collection.git cp -r claude-skills-collection/dev-skills/api-doc-generator ~/.claude/skills/

Source : dev-skills/api-doc-generator

📖 Manuel

API Doc Generator

Workflow

  1. Détection : identifie le framework (Express, FastAPI, Django, Laravel…) et le type d'API.
  2. Extraction : pour chaque endpoint, documente :
    • Méthode HTTP + URL
    • Description courte
    • Paramètres (path, query, body) avec types et obligatoire/optionnel
    • Headers requis
    • Réponses possibles (200, 400, 401, 404, 500) avec exemples JSON
    • Authentification requise
  3. Format de sortie : tableau Markdown structuré ou format OpenAPI simplifié.
  4. Exemples : génère des exemples de requêtes cURL pour chaque endpoint.
  5. Résumé : table des routes avec méthode, URL et description.

Règles