Elysia Tools Docs
RU
Язык
ZHESPTRUFRDEEN
На сайт
Обзор инструментов

Development

Генератор API Документации

Создает аккуратную API документацию из OpenAPI или аннотированных комментариев

file· Файловый результатОткрыть инструмент

Быстрый старт

Вызовите этот инструмент из своего кода на трёх языках.

cURL
curl -X POST 'https://api.elysiatools.com/ru/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. Документация для разработчиков.

На сайтОбзор инструментов

Справочник API

Отправьте POST-запрос с входными данными в JSON. Параметры типа «файл» требуют предварительной загрузки.

Endpoint

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

Параметры

ИмяТипОбязательныйОписание
sourceTexttextareaДа—
sourceFormatselectНет—
outputFormatselectНет—
documentTitletextНет—
themeselectНет—
includeExamplescheckboxНет—
includeSchemascheckboxНет—

Формат ответа

Файловый результат

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

Интеграция MCP

Добавьте этот инструмент на свой сервер Model Context Protocol, чтобы ИИ-агенты могли перечислять и вызывать его.

Конфигурация сервера

Добавьте этот блок в конфигурацию вашего MCP-клиента:

mcp.json
{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "Создает аккуратную API документацию из OpenAPI или аннотированных комментариев",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Получить список инструментов

После подключения к SSE-endpoint выведите список доступных инструментов:

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

Вызвать этот инструмент

Вызовите инструмент по его id; аргументы формируются из его параметров:

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
}
  }
}
Объединяйте несколько инструментов в одной сессии списком toolId через запятую, напр. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (макс. 20).

Вопросы или проблемы? Свяжитесь с [email protected]

Обзор инструментов
Открыть инструмент