Development

API Doku Generator

Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext

Schnellstart

Rufen Sie dieses Werkzeug aus Ihrem Code in drei Sprachen auf.

cURL

curl -X POST 'https://api.elysiatools.com/de/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}'

API-Referenz

Senden Sie eine POST-Anfrage mit Ihren Eingaben als JSON. Dateiparameter erfordern einen vorherigen Upload.

Endpunkt

HTTP

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

Parameter

Name	Typ	Erforderlich	Beschreibung
sourceText	textarea	Ja	—
sourceFormat	select	Nein	—
outputFormat	select	Nein	—
documentTitle	text	Nein	—
theme	select	Nein	—
includeExamples	checkbox	Nein	—
includeSchemas	checkbox	Nein	—

Antwortformat

Dateiergebnis

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-Integration

Fügen Sie dieses Werkzeug Ihrem Model-Context-Protocol-Server hinzu, damit KI-Agenten es auflisten und aufrufen können.

Serverkonfiguration

Fügen Sie diesen Block Ihrer MCP-Client-Konfiguration hinzu:

mcp.json

{
  "mcpServers": {
    "elysiatools-api-doc-generator": {
      "name": "api-doc-generator",
      "description": "Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=api-doc-generator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Verfügbare Werkzeuge auflisten

Nach dem Verbinden mit dem SSE-Endpunkt listen Sie die bereitgestellten Werkzeuge auf:

tools/list

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

Dieses Werkzeug aufrufen

Rufen Sie das Werkzeug über seine ID auf; Argumente werden aus seiner Parameterliste gebildet:

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

Verketten Sie mehrere Werkzeuge in einer Sitzung mit einer kommagetrennten toolId-Liste, z. B. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (max. 20).

Fragen oder Probleme? Kontakt: [email protected]