Elysia Tools Docs
ES
Idioma
ZHESPTRUFRDEEN
Volver al sitio
Explorar herramientas

Development

Generador de Documentacion API

Genera documentacion API elegante desde OpenAPI o comentarios anotados

file· Resultado de archivoAbrir herramienta

Inicio rápido

Llama a esta herramienta desde tu código en tres lenguajes.

cURL
curl -X POST 'https://api.elysiatools.com/es/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. Documentación para desarrolladores.

Volver al sitioExplorar herramientas

Referencia de la API

Envía una petición POST con tus entradas en JSON. Los parámetros de tipo archivo requieren una subida previa.

Endpoint

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

Parámetros

NombreTipoObligatorioDescripción
sourceTexttextareaSí—
sourceFormatselectNo—
outputFormatselectNo—
documentTitletextNo—
themeselectNo—
includeExamplescheckboxNo—
includeSchemascheckboxNo—

Formato de respuesta

Resultado de archivo

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

Integración MCP

Añade esta herramienta a tu servidor Model Context Protocol para que los agentes de IA puedan listarla y llamarla.

Configuración del servidor

Añade este bloque a la configuración de tu cliente MCP:

mcp.json
{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "Genera documentacion API elegante desde OpenAPI o comentarios anotados",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Listar herramientas disponibles

Tras conectar al endpoint SSE, lista las herramientas expuestas:

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

Llamar a esta herramienta

Invoca la herramienta por su id; los argumentos se construyen a partir de sus parámetros:

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
}
  }
}
Encadena varias herramientas en una sesión con una lista toolId separada por comas, p. ej. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (máx. 20).

¿Dudas o problemas? Contacta con [email protected]

Explorar herramientas
Abrir herramienta