Generateur de Documentation API

Genere une documentation API elegante a partir de OpenAPI ou de commentaires annotés

Produit une documentation HTML, Markdown ou PDF avec parametres, schemas, exemples de requete et codes d erreur.

Exemples de résultats

2 Exemples

Generer une doc Markdown depuis OpenAPI

Transforme un document OpenAPI compact en reference Markdown avec parametres, reponses, schemas et erreurs.

# Demo User API

Version: 1.2.0

## Endpoints

### GET /users/{id}

**Summary:** Get user by ID
Voir paramètres d'entrée
{ "sourceText": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"title\": \"Demo User API\",\n \"version\": \"1.2.0\",\n \"description\": \"User management endpoints\"\n },\n \"servers\": [\n {\n \"url\": \"https://api.example.com\"\n }\n ],\n \"paths\": {\n \"/users/{id}\": {\n \"get\": {\n \"summary\": \"Get user by ID\",\n \"tags\": [\n \"users\"\n ],\n \"parameters\": [\n {\n \"in\": \"path\",\n \"name\": \"id\",\n \"required\": true,\n \"description\": \"User identifier\",\n \"schema\": {\n \"type\": \"string\",\n \"example\": \"u_123\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"User payload\",\n \"content\": {\n \"application/json\": {\n \"example\": {\n \"id\": \"u_123\",\n \"name\": \"Ada\"\n }\n }\n }\n },\n \"404\": {\n \"description\": \"User not found\"\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}", "sourceFormat": "json", "outputFormat": "markdown", "documentTitle": "Demo User API", "theme": "slate", "includeExamples": true, "includeSchemas": true }

Rendre des commentaires structures en HTML interactif

Utilise des balises de commentaires structurees pour generer une page HTML sans exemples ni schemas.

POST/invoices

Create invoice

Voir paramètres d'entrée
{ "sourceText": "@title Billing API\n@version 0.9.0\n@description Lightweight annotated API example\n@route POST /invoices\n@summary Create invoice\n@tag billing\n@query customerId string - Customer identifier\n@bodyparam amount number optional - Requested invoice total\n@request {\"customerId\":\"cust_1\",\"amount\":129.5}\n@response 201 Created\n@error 422 Validation failed", "sourceFormat": "comments", "outputFormat": "html", "documentTitle": "Billing API", "theme": "paper", "includeExamples": false, "includeSchemas": false }

Points clés

Catégorie
Développement et Web
Types d’entrée
textarea, select, text, checkbox
Type de sortie
file
Couverture des échantillons
4
API disponible
Yes

Vue d’ensemble

Ce générateur transforme vos spécifications OpenAPI (JSON/YAML) ou commentaires annotés en documentation API élégante et structurée. Il produit des fichiers HTML interactifs, Markdown ou PDF complets, incluant paramètres, schémas, exemples de requêtes et codes d'erreur, prêts à être partagés avec vos équipes ou clients.

Quand l’utiliser

  • •Vous disposez d'une spécification OpenAPI/Swagger et souhaitez générer une référence technique lisible sans écrire de documentation manuelle.
  • •Vous utilisez des commentaires structurés dans votre code source et devez les convertir en documentation HTML ou PDF exploitable.
  • •Vous devez livrer une documentation API aux parties prenantes dans un format spécifique (Markdown pour GitHub, PDF pour contrats, HTML pour portails).

Comment ça marche

  • •Collez votre contenu source dans le champ dédié : spécification OpenAPI au format JSON ou YAML, ou commentaires annotés selon la syntaxe supportée.
  • •Sélectionnez le format source (détection automatique, JSON, YAML ou commentaires) et choisissez le format de sortie souhaité : HTML interactif, Markdown ou PDF.
  • •Personnalisez le titre du document, choisissez un thème visuel (Ardoise ou Papier) et cochez les options pour inclure ou exclure les exemples et schémas.
  • •Générez le fichier de documentation structuré contenant endpoints, paramètres, corps de requête, réponses et codes d'erreur.

Cas d’usage

Rédacteurs techniques transformant des fichiers Swagger en références Markdown pour dépôts GitHub ou wikis internes.
Développeurs backend documentant des API légères via des commentaires structurés directement dans le code source.
Équipes produit générant des spécifications PDF formelles à inclure dans des contrats clients ou dossiers de conformité.

Exemples

1. Documentation Markdown pour API Utilisateurs

Rédacteur technique
Contexte
L'équipe dispose d'une spécification OpenAPI 3.0 décrivant les endpoints de gestion utilisateurs mais manque de documentation lisible pour les développeurs frontaux.
Problème
Créer manuellement une documentation Markdown à jour est chronophage et source d'erreurs de synchronisation avec le code.
Comment l’utiliser
Collez le JSON OpenAPI dans le champ Source API, sélectionnez 'Markdown' comme format de sortie, activez l'inclusion des exemples et schémas, puis définissez le titre du document.
Résultat
Un fichier Markdown structuré présentant les endpoints GET/POST, paramètres de chemin, corps de requête, exemples de réponses JSON et codes d'erreur 404/200.

2. Page HTML interactive depuis commentaires annotés

Développeur backend
Contexte
Un microservice de facturation documenté via des commentaires structurés dans le code (@route, @param) nécessite une documentation consultable par le support client.
Problème
Les commentaires bruts ne sont pas exploitables par les équipes non techniques et il faut un rendu visuel clair sans schémas complexes.
Comment l’utiliser
Insérez les commentaires annotés dans le champ source, choisissez le format 'Commentaires annotés', sélectionnez 'HTML interactif' avec le thème 'Papier' et désactivez les options d'exemples et schémas.
Résultat
Une page HTML épurée affichant la méthode POST /invoices, les paramètres de requête customerId et amount, ainsi que les réponses 201 et 422.

3. Spécification PDF pour validation client

Chef de projet technique
Contexte
Le client final exige une documentation PDF formelle des endpoints API avant signature du contrat de maintenance.
Problème
L'équipe ne dispose que du fichier OpenAPI YAML et doit produire un document professionnel imprimable rapidement.
Comment l’utiliser
Collez le YAML OpenAPI, sélectionnez 'PDF' comme format de sortie, choisissez le thème 'Ardoise' pour un rendu professionnel, et activez l'inclusion des schémas pour exhaustivité.
Résultat
Un document PDF complet listant tous les endpoints, paramètres d'entrée/sortie, codes d'erreur et schémas JSON, prêt pour la revue client.

Tester avec des échantillons

html, markdown, pdf
Exemples PDF
Exemples PDF generes par les outils du 2026-02-01 au 2026-02-10
matched family markdown,pdf,text
markdown, pdf
Exemples de Slides Markdown
Presentations Markdown style Remark/Marp pour tester l export PDF
matched family markdown,pdf,text
markdown, pdf
Exemples OpenAI API
Exemples complets de l'API OpenAI incluant les modèles GPT, la génération d'images DALL-E, le traitement audio Whisper et les appels de fonctions
title token api
text
API Graphique WebGPU
API graphique moderne pour les graphiques 3D haute performance et le calcul GPU dans le navigateur
title token api
text

Hubs associés

Outils OpenAPI pour documentation, génération de code et revue de contrat
Comparez génération de code OpenAPI, documentation API, diff de schémas, validation de réponses et tests de contrat dans un hub unique pour la conception et la maintenance d’API.
Outils de test de contrats API, de mock et de revue de schémas
Générez des types et de la documentation depuis OpenAPI, créez des mocks, validez des réponses réelles et passez en revue les changements de schéma risqués dans un seul hub.
Outils de conversion de casse, d’encodage et de normalisation de texte
Comparez les outils de conversion de casse, de largeur de caractères, d’encodage, de quoted-printable et de normalisation de texte dans un hub unique.
Outils de conversion PDF et d export documentaire
Comparez les outils qui convertissent des documents, images et extractions structurees vers ou depuis PDF dans un meme hub.

FAQ

Quels formats d'entrée sont supportés ?

OpenAPI 3.0 en JSON ou YAML, ainsi que des commentaires de code annotés selon une syntaxe structurée (@route, @param, etc.).

Puis-je obtenir une documentation au format PDF ?

Oui, l'outil génère des documents PDF prêts à l'impression ou à l'archivage, en plus du HTML et Markdown.

La détection du format source est-elle automatique ?

Oui, vous pouvez activer la détection automatique ou spécifier manuellement si votre entrée est du JSON, YAML ou des commentaires.

Est-il possible d'exclure les schémas techniques ?

Oui, les cases à cocher permettent d'inclure ou d'exclure les exemples de requêtes et les schémas selon vos besoins.

Quelle est la différence entre les thèmes Ardoise et Papier ?

Le thème Ardoise offre un rendu sombre moderne idéal pour les portails web, tandis que Papier propose un style clair optimisé pour l'impression et la lecture PDF.

Documentation de l'API

Point de terminaison de la requête

POST /fr/api/tools/api-doc-generator

Paramètres de la requête

Nom du paramètre Type Requis Description
sourceText textarea Oui -
sourceFormat select Non -
outputFormat select Non -
documentTitle text Non -
theme select Non -
includeExamples checkbox Non -
includeSchemas checkbox Non -

Format de réponse

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Fichier: Fichier

Documentation de MCP

Ajoutez cet outil à votre configuration de serveur MCP: 

{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "Genere une documentation API elegante a partir de OpenAPI ou de commentaires annotés",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Vous pouvez chaîner plusieurs outils, par ex.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, max 20 outils.

Si vous rencontrez des problèmes, veuillez nous contacter à [email protected]