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.

Elysia Tools

Mobile Navigation

Development

API Doku Generator

Erstellt ansprechende API Dokumentation aus OpenAPI oder kommentiertem Quelltext

Einzelheiten

Wobei dieses Tool hilft

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

Ausführung

Dieses Tool ausführen

Fülle das Formular aus, starte das Tool und prüfe das Ergebnis an einem Ort.

Vorbereitete Beispielausführungen

Klicken Sie auf ein Beispiel, um das Formular automatisch auszufüllen. Dateien müssen weiterhin hochgeladen werden.

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

Kommentierte Hinweise als interaktives HTML rendern

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

<article class="endpoint"><div class="endpoint-header"><span class="method">POST</span><code>/invoices</code></div><h3>Create invoice</h3>

Eingaben

Fülle die erforderlichen Felder aus und starte das Tool.

7 Optionen

InhaltHaupteingaben einfügen oder eingeben.2

API QuelletextareaPflichtDokumenttiteltextOptionales Feld

EinstellungenFormate, Bereiche, Zahlen und Modi anpassen.3

QuellformatselectOptionales FeldAusgabeformatselectOptionales FeldThemaselectOptionales Feld

SchalterOptionales Verhalten aktivieren oder deaktivieren.2

Beispiele einbeziehencheckboxOptionales FeldAktiviert, wenn ausgewähltSchemas einbeziehencheckboxOptionales FeldAktiviert, wenn ausgewählt

Ergebnis

Bereit zum Start

Nach dem Ausführen erscheinen hier Dateien, Text, strukturierte Daten oder Stream-Ausgaben.

Beispiele

Beispiele zu diesem Tool

Verwandt

API Doku Generator

Wobei dieses Tool hilft

Dieses Tool ausführen

Vorbereitete Beispielausführungen

Eingaben

Ergebnis

Beispiele zu diesem Tool

Mit verwandten Tools und Themen fortfahren

Vorbereitete Beispielausführungen

Eingaben

Ergebnis

Erfahren Sie, wann dieses Tool passt, was es unterstützt und wie Nutzer es anwenden.

Wichtige Fakten

Überblick

Wann verwenden

So funktioniert es

Anwendungsfälle

Beispiele

1. Markdown-Doku für Entwickler-Wiki

2. Interaktive HTML-Seite aus Code-Kommentaren

FAQ

Markdown Foliensatz Beispiele

PDF-Beispiele

Markdown-Beispiele

Markdown-Viewer Beispiele

Data-URI-Generator

Barrierefreiheits-Auditbericht-Generator

PDF-Kopf-/Fußzeilen-Bausteine

PDF-Rechnungsgenerator

Werkzeuge fur Dokumentations-Authoring, Extraktion und Publishing

OpenAPI-Tools für Dokumentation, Codegenerierung und Vertragsreview

API-Vertragstest-, Mocking- und Schema-Review-Tools

Tools fur API-Versionierung, Breaking Changes und Release-Readiness-Prufung

3. PDF-Handout für Stakeholder-Meetings