API Doku Generator

Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext

Verwandte Tags

PDF 113 HTML/CSS 58 Markdown 28 API 19 OpenAPI 7

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: Entwicklung & Web
Eingabetypen: textarea, select, text, checkbox
Ausgabetyp: file
Sample-Abdeckung: 4
API verfügbar: Yes

Überblick

Der API Doku Generator erstellt aus OpenAPI-Spezifikationen (JSON/YAML) oder strukturierten Code-Kommentaren professionelle Dokumentationen. Das Tool wandelt technische API-Definitionen in lesbare HTML-, Markdown- oder PDF-Dokumente um und integriert dabei Parameterbeschreibungen, Request-Body-Definitionen, Antwortbeispiele sowie Fehlercodes.

Wann verwenden

•Wenn Sie aus einer OpenAPI-Datei eine übersichtliche Entwickler-Dokumentation erstellen müssen
•Wenn Sie aus kommentiertem Quelltext schnell eine API-Referenz generieren wollen
•Wenn Sie Dokumentation in verschiedenen Formaten (HTML für Web, Markdown für Wikis, PDF für Druck) bereitstellen müssen

So funktioniert es

•Fügen Sie den OpenAPI-Code (JSON oder YAML) oder die annotierten Kommentare in das Feld 'API Quelle' ein
•Wählen Sie das Quellformat (Automatisch, JSON, YAML oder Kommentierte Hinweise) und das gewünschte Ausgabeformat (HTML, Markdown oder PDF)
•Passen Sie den Dokumenttitel, das visuelle Thema (Schiefer oder Papier) sowie die Einbindung von Beispielen und Schemas an
•Das Tool generiert die formatierte Dokumentation als Datei zum Herunterladen

Anwendungsfälle

Erstellung von Entwickler-Handbüchern aus OpenAPI-Spezifikationen für öffentliche oder interne APIs

Schnelle Dokumentation von Prototypen aus Code-Kommentaren für Team-Workshops

Generierung von PDF-Referenzen für Vertragsunterlagen oder Kunden-Handouts

Beispiele

1. Markdown-Doku für Entwickler-Wiki

Backend-Entwickler

Hintergrund: Ein Team hat eine REST-API mit OpenAPI 3.0 spezifiziert und benötigt eine lesbare Dokumentation für das interne Confluence-Wiki.
Problem: Die Roh-OpenAPI-JSON-Datei ist schwer lesbar und muss in eine strukturierte Markdown-Referenz mit Parametern und Fehlercodes umgewandelt werden.
Verwendung: Fügen Sie den OpenAPI-JSON-Code in 'API Quelle' ein, wählen Sie 'OpenAPI JSON' als Quellformat und 'Markdown' als Ausgabeformat. Aktivieren Sie 'Schemas einbeziehen'.
Beispielkonfiguration: sourceFormat: json, outputFormat: markdown, includeSchemas: true, theme: slate
Ergebnis: Eine gut strukturierte Markdown-Datei mit allen Endpunkten, Parametern, Antwortbeispielen und Schemas, die direkt ins Wiki eingecheckt werden kann.

2. Interaktive HTML-Seite aus Code-Kommentaren

Freelance-Entwickler

Hintergrund: Ein Freelancer hat eine kleine Billing-API ohne formale OpenAPI-Spezifikation, aber mit strukturierten Kommentaren im Quellcode.
Problem: Es fehlt eine visuell ansprechende Dokumentation für den Kunden, und manuelles Schreiben wäre zu zeitaufwändig.
Verwendung: Kopieren Sie die annotierten Kommentare (@route, @param, etc.) in das Textfeld, wählen Sie 'Kommentierte Hinweise' als Quellformat und 'Interaktives HTML' als Ausgabe.
Beispielkonfiguration: sourceFormat: comments, outputFormat: html, theme: paper, includeExamples: false
Ergebnis: Eine interaktive HTML-Seite mit Endpunkten und Parametern, die im Browser geöffnet oder als statische Seite deployt werden kann.

3. PDF-Handout für Stakeholder-Meetings

Product Owner

Hintergrund: Der Product Owner benötigt eine druckbare Version der API-Spezifikation für ein Review-Meeting mit nicht-technischen Stakeholdern.
Problem: Technische YAML-Dateien sind für Business-Stakeholder unverständlich und ungeeignet zum Ausdrucken.
Verwendung: Fügen Sie die OpenAPI-YAML ein, wählen Sie 'PDF' als Ausgabeformat und 'Papier' als Thema für optimale Lesbarkeit beim Drucken.
Ergebnis: Ein professionelles PDF-Dokument mit allen Endpunkten und Beschreibungen, bereit zum Ausdrucken oder Versenden per E-Mail.

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

OpenAI API Beispiele

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

title token api

text

WebGPU Grafik-API

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

title token api

text

FAQ

Welche Eingabeformate werden unterstützt?

Das Tool akzeptiert OpenAPI JSON, OpenAPI YAML und strukturierte Kommentare (annotated comments) als Eingabe.

Kann ich die Dokumentation als PDF erhalten?

Ja, neben interaktivem HTML und Markdown steht auch PDF als Ausgabeformat zur Verfügung.

Werden Request- und Response-Beispiele automatisch eingefügt?

Ja, sofern die Option 'Beispiele einbeziehen' aktiviert ist und die Eingabedaten Beispiele enthalten.

Was ist der Unterschied zwischen den Themen 'Schiefer' und 'Papier'?

Dies sind visuelle Stile für die HTML-Ausgabe: Schiefer bietet ein dunkles, Papier ein helles Erscheinungsbild.

Muss ich das Quellformat manuell angeben?

Nein, die automatische Erkennung funktioniert zuverlässig, Sie können aber bei Bedarf JSON, YAML oder Kommentare explizit wählen.

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]