Kategorien

API Doku Generator

Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext

Erzeugt HTML, Markdown oder PDF API Doku mit Parametern, Request Bodies, Antwortbeispielen und Fehlercodes.

Beispielergebnisse

2 Beispiele

Markdown-Doku aus OpenAPI erzeugen

Wandelt ein kompaktes OpenAPI-Dokument in eine Markdown-Referenz mit Parametern, Antworten, Schemas und Fehlern um.

# Demo User API

Version: 1.2.0

## Endpoints

### GET /users/{id}

**Summary:** Get user by ID

Eingabeparameter anzeigen

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

Kommentierte Hinweise als interaktives HTML rendern

Erzeugt aus strukturierten Kommentar-Tags eine HTML-API-Seite ohne Beispiele und Schema-Bloecke.

POST/invoices

Create invoice

Eingabeparameter anzeigen

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

API Quelle *

Quellformat

Ausgabeformat

Dokumenttitel

Thema

Beispiele einbeziehen

Schemas einbeziehen

Wichtige Fakten

Kategorie: Development
Eingabetypen: textarea, select, text, checkbox
Ausgabetyp: file
Sample-Abdeckung: 4
API verfügbar: Yes

Überblick

API Doc Generator wandelt OpenAPI Spezifikationen oder strukturierte Kommentare in gut lesbare und sauber aufbereitete API Dokumentation um.

Wann verwenden

•Wenn Sie HTML, Markdown und PDF aus derselben Quelle erzeugen wollen.
•Wenn Parameter, Responses und Fehlercodes in einer konsistenten Referenz gesammelt werden sollen.
•Wenn bereits Swagger oder OpenAPI vorhanden ist, aber die Darstellung verbessert werden muss.
•Wenn nur kommentierte API Beschreibungen existieren und noch keine formale Dokumentationsseite.

So funktioniert es

•Sie fuegen OpenAPI JSON, YAML oder strukturierte Kommentare ein.
•Das Tool extrahiert Endpunkte, Parameter, Request Bodies, Responses und Fehler.
•Anschliessend erstellt es daraus eine aufgeraeumte API Referenz.
•Beispiele und Schemas lassen sich fuer technische Leser mit ausgeben.

Anwendungsfälle

Interne API Referenzen fuer Backend oder Platform Teams.

Partnerdokumentation fuer externe Integrationen.

PDF Export fuer Audits, Uebergaben oder Onboarding.

Markdown Dokumentation fuer das Repository.

Beispiele

1. Partnerfaehige API Doku aus vorhandenem OpenAPI Spec erstellen

Backend Entwickler

Hintergrund: Ein Team pflegt bereits eine OpenAPI Spezifikation fuer einen Zahlungsdienst.
Problem: Es braucht eine besser praesentierbare Dokumentation fuer externe Partner.
Verwendung: Die Spezifikation einfuegen, Beispiele aktivieren und als HTML oder PDF exportieren.
Beispielkonfiguration: Quellformat: Auto Detect. Ausgabe: Interaktives HTML oder PDF.
Ergebnis: Das Team erhaelt eine saubere API Referenz mit Endpunkten, Parametern, Schemas und Responses.

Mit Samples testen

html, markdown, pdf

PDF-Beispiele

Generierte PDF-Beispiele von Tools zwischen 2026-02-01 und 2026-02-10

matched family markdown,pdf,text

markdown, pdf

Markdown Foliensatz Beispiele

Remark/Marp Markdown Decks zum Testen des PDF Exports

matched family markdown,pdf,text

markdown, pdf

WebGPU Grafik-API

Moderne Grafik-API für hochperformante 3D-Grafik und GPU-Computing im Browser

title token api

text

OpenAI API Beispiele

Umfassende OpenAI API Beispiele einschließlich GPT-Modelle, DALL-E Bildgenerierung, Whisper Audioverarbeitung und Funktionsaufrufe

title token api

text

FAQ

Unterstuetzt das Tool Swagger oder OpenAPI?

Ja. Es verarbeitet JSON und YAML im Swagger oder OpenAPI Stil.

Koennen Response Beispiele und Fehlercodes angezeigt werden?

Ja. Wenn diese Daten in der Quelle vorhanden sind, erscheinen sie auch in der Dokumentation.

Laesst sich in mehrere Formate exportieren?

Ja. Dieselbe Quelle kann als HTML, Markdown oder PDF ausgegeben werden.

Ist das Tool auch ohne vollstaendige Spezifikation nuetzlich?

Ja. Strukturierte Kommentare eignen sich gut fuer fruehe oder teilweise dokumentierte APIs.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/api-doc-generator

Request-Parameter

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

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

Datei: Datei

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu:

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

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]