Elysia Tools Docs
FR
Langue
ZHESPTRUFRDEEN
Retour au site
Parcourir les outils

Development

Generateur de Documentation API

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

file· Résultat fichierOuvrir l'outil

Démarrage rapide

Appelez cet outil depuis votre code en trois langages.

cURL
curl -X POST 'https://api.elysiatools.com/fr/api/tools/api-doc-generator' \
  -H 'Content-Type: application/json' \
  -d '{"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}'

© 2026 Elysia Tools. Documentation développeur.

Retour au siteParcourir les outils

Référence de l'API

Envoyez une requête POST avec vos entrées en JSON. Les paramètres de type fichier nécessitent un upload préalable.

Point d'accès

HTTP
POST https://api.elysiatools.com/fr/api/tools/api-doc-generator

Paramètres

NomTypeRequisDescription
sourceTexttextareaOui—
sourceFormatselectNon—
outputFormatselectNon—
documentTitletextNon—
themeselectNon—
includeExamplescheckboxNon—
includeSchemascheckboxNon—

Format de réponse

Résultat fichier

JSON
{
  "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)"
}

Intégration MCP

Ajoutez cet outil à votre serveur Model Context Protocol pour que les agents IA puissent le lister et l'appeler.

Configuration du serveur

Ajoutez ce bloc à la configuration de votre client MCP :

mcp.json
{
  "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://api.elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Lister les outils disponibles

Après connexion au point d'accès SSE, listez les outils exposés :

tools/list
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

Appeler cet outil

Appelez l'outil par son id ; les arguments sont construits à partir de ses paramètres :

tools/call
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "api-doc-generator",
    "arguments": {
  "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
}
  }
}
Chaînez plusieurs outils dans une session avec une liste toolId séparée par des virgules, ex. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (20 max).

Des questions ou un problème ? Contactez [email protected]

Parcourir les outils
Ouvrir l'outil