Catégories

← View All Tools

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
Development
Types d’entrée
textarea, select, text, checkbox
Type de sortie
file
Couverture des échantillons
4
API disponible
Yes

Vue d’ensemble

API Doc Generator transforme une specification OpenAPI ou des commentaires structures en documentation API propre, lisible et facile a diffuser.

Quand l’utiliser

  • •Quand vous voulez produire HTML, Markdown et PDF a partir dune meme source.
  • •Quand il faut reunir endpoints, parametres, reponses et erreurs dans une reference unique.
  • •Quand vous avez deja un Swagger/OpenAPI mais pas une presentation suffisamment claire.
  • •Quand la documentation repose encore surtout sur des commentaires annotés.

Comment ça marche

  • •Collez le contenu OpenAPI JSON, YAML ou des commentaires structures.
  • •Loutil extrait les endpoints, parametres, corps de requete, reponses et erreurs.
  • •Il organise ensuite ces donnees dans une documentation cohérente.
  • •Vous pouvez conserver schemas et exemples pour un usage technique.

Cas d’usage

Publier une reference interne pour les equipes backend.
Partager une documentation d integration avec des partenaires.
Generer un PDF pour audit, livraison ou onboarding.
Produire une version Markdown a enregistrer dans le depot.

Exemples

1. Publier une documentation partenaire a partir dun spec existant

Developpeur backend
Contexte
Une equipe dispose deja dune specification OpenAPI pour un service de paiement.
Problème
Elle veut une documentation plus presentable pour ses partenaires externes.
Comment l’utiliser
Collez le spec, activez les exemples et exportez en HTML ou PDF.
Configuration d’exemple
Format source : Auto Detect. Sortie : HTML interactif ou PDF.
Résultat
Lequipe obtient une reference claire avec endpoints, parametres, schemas et reponses.

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
API Graphique WebGPU
API graphique moderne pour les graphiques 3D haute performance et le calcul GPU dans le navigateur
title token api
text
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

Hubs associés

Outils Html pour Convert
Découvrez 11 outils html pour des workflows de convert et comparez rapidement des utilitaires proches.
Outils Text pour Convert
Découvrez 80 outils text pour des workflows de convert et comparez rapidement des utilitaires proches.
Outils Pdf pour Convert
Découvrez 28 outils pdf pour des workflows de convert et comparez rapidement des utilitaires proches.
Outils Markdown pour Convert
Découvrez 15 outils markdown pour des workflows de convert et comparez rapidement des utilitaires proches.

FAQ

La specification Swagger ou OpenAPI est-elle prise en charge ?

Oui. Loutil accepte les entrees JSON et YAML au format OpenAPI ou Swagger.

Peut-on inclure des exemples et des codes derreur ?

Oui. Si ces donnees existent dans la source, elles peuvent etre affichees dans la sortie.

Peut-on exporter dans plusieurs formats ?

Oui. La meme source peut etre generee en HTML interactif, Markdown ou PDF.

Est-ce utile sans specification OpenAPI complete ?

Oui. Les commentaires structures permettent deja de produire une base de documentation.

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]