# API Doku Generator Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext > Kanonische Seite: https://elysiatools.com/de/tools/api-doc-generator - **Kategorie:** Development - **Schlagwörter:** api, openapi, swagger, dokumentation, html, markdown, pdf ## Überblick Erzeugt HTML, Markdown oder PDF API Doku mit Parametern, Request Bodies, Antwortbeispielen und Fehlercodes. ## Eingaben - **API Quelle** (textarea): Paste OpenAPI JSON/YAML or annotated comments here... - **Quellformat** (select) - **Ausgabeformat** (select) - **Dokumenttitel** (text): API Reference - **Thema** (select) - **Beispiele einbeziehen** (checkbox) - **Schemas einbeziehen** (checkbox) ## 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 ## Funktionsweise - 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 ## Häufig gestellte Fragen ### 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. ## Ähnliche Tools - [Data-URI-Generator](https://elysiatools.com/de/tools/data-uri-generator): Konvertiert Dateien in Data URIs (Base64 oder prozent-kodiert), um Bilder, Schriftarten und Ressourcen direkt in HTML, CSS oder Markdown einzubetten - [Barrierefreiheits-Auditbericht-Generator](https://elysiatools.com/de/tools/accessibility-audit-report-generator): Prueft HTML oder eine URL auf haeufige WCAG-Probleme und exportiert einen strukturierten PDF-Bericht - [PDF-Kopf-/Fußzeilen-Bausteine](https://elysiatools.com/de/tools/pdf-header-footer-snippets): Konvertiert HTML zu PDF und fügt Logo-, Titel- und Datumsbausteine hinzu - [PDF-Rechnungsgenerator](https://elysiatools.com/de/tools/pdf-invoice-generator): Erstellt eine gebrandete PDF-Rechnung aus strukturierten Positionen - [PDF-Bild- und Caption-Extraktor](https://elysiatools.com/de/tools/pdf-image-caption-extractor): Extrahiert PDF-Bilder, ordnet nahe Captions zu und erstellt einen durchsuchbaren HTML-Index - [PDF-zu-strukturiertem-Markdown-Konverter](https://elysiatools.com/de/tools/pdf-to-structured-markdown-converter): Wandelt PDF mit OpenDataLoader in strukturiertes Markdown mit HTML-, Bild- und Seitentrenner-Optionen um - [Konverter fuer verschluesseltes PDF](https://elysiatools.com/de/tools/encrypted-pdf-converter): Oeffnet geschuetzte PDFs mit dem richtigen Passwort und exportiert sie als Markdown, JSON oder Text - [Markdown-zu-PDF-Theme-Paket](https://elysiatools.com/de/tools/markdown-to-pdf-theme-pack): Konvertiert Markdown zu PDF mit Hell-, Dunkel- oder Druckthema ## Beispiele - [Markdown Foliensatz Beispiele](https://elysiatools.com/de/samples/md-slide-deck-to-pdf): Remark/Marp Markdown Decks zum Testen des PDF Exports - [PDF-Beispiele](https://elysiatools.com/de/samples/pdf-samples): Generierte PDF-Beispiele von Tools zwischen 2026-02-01 und 2026-02-10 - [Markdown-Beispiele](https://elysiatools.com/de/samples/markdown-samples): Markdown-Formatbeispiele von einfachen bis komplexen Dokumentstrukturen - [Markdown-Viewer Beispiele](https://elysiatools.com/de/samples/markdown-viewer-samples): Markdown-Beispiele fur README-Vorschau, Dokumentations-Rendering und Markup-Tests ## Verwandte Inhalte - [Dokumentation verfassen, pruefen und veroeffentlichen](https://elysiatools.com/de/hubs/documentation-authoring-publishing): Material aus Code, PDF oder HTML extrahieren und daraus eine veroeffentlichbare Dokumentation zusammenfuehren, pruefen, anzeigen und exportieren. - [API-Verträge definieren, Schemas validieren und Änderungen testen](https://elysiatools.com/de/hubs/api-contract-testing): Definieren Sie einen API-Vertrag, prüfen Sie Schemas und aufgezeichnete Payloads, erkennen Sie Kompatibilitätsrisiken und dokumentieren Sie die Abnahme. - [OpenAPI Utility Workflow](https://elysiatools.com/de/hubs/openapi-utility): Erzeuge OpenAPI-Typen und Doku, pruefe Breaking Changes, validiere Responses und haerte den Vertrag mit Stress- und Mutationstests.