Über OpenAPI / Swagger Betrachter — Ausführliche Anleitung
Der OpenAPI Viewer ist ein clientseitiger Dokumentations-Reader zur Inspektion von RESTful-API-Verträgen. Er rendert Swagger 2.0- sowie OpenAPI 3.0- / 3.1-Spezifikationen in JSON oder YAML, ohne dass eine lokale Swagger UI-Installation oder Cloud-Abhängigkeiten erforderlich sind.
Er bietet eine übersichtliche, gruppierte Sidebar-Navigation für alle Endpunkte und zeigt Pfade, HTTP-Methoden (GET, POST, PUT, DELETE), Header-Parameter, Query-Strings, strukturierte Request-Bodies, HTTP-Statuscodes und Datenschemata an.
Kernfunktionen & Eigenschaften
- Unterstützt Swagger 2.0- und OpenAPI 3.0- / 3.1-Spezifikationen in JSON und YAML
- Interaktive Seitenleiste mit kategorisierten Endpunkten, HTTP-Methoden und Statuscodes
- Tiefgehende `$ref`-Schemaauflösung zur Anzeige verschachtelter Datenmodelle und Eigenschaftsbeschränkungen
- 100 % clientseitiges Offline-Parsing zum Schutz proprietärer Unternehmens-API-Verträge
Anleitung
- 1
Fügen Sie Ihren `swagger.json`- oder `openapi.yaml`-Text ein oder laden Sie die Spezifikationsdatei direkt hoch.
- 2
Durchsuchen Sie die strukturierte API-Dokumentation im interaktiven Viewer.
- 3
Klappen Sie einen beliebigen Endpunkt auf, um Request-Header, Schemata für Request-Payloads und Antwortbeispiele einzusehen.
Typische Anwendungsfälle
- → Auditing von Backend-API-Definitionen ohne Bereitstellung eines dedizierten Swagger UI-Servers
- → Plausibilitätsprüfung handgeschriebener OpenAPI-Spezifikationen auf ungültige `$ref`-Zeiger
- → Bereitstellung präziser Schemareferenzen für Frontend-Entwickler bei API-Integrationen
Ähnliche Tools
SEO Meta-Tag-Generator
Erstellung von HTML-Meta-Tags, Open Graph und Twitter Cards für Suchmaschinenoptimierung.
.gitignore-Generator
Schnelle Erstellung von .gitignore-Dateien für Sprachen und Frameworks (Node, Python, Go etc.).
Open-Source-Lizenzgenerator
Erstellung von Open-Source-Lizenzen (MIT, Apache 2.0, GPL v3, BSD) mit Copyright-Informationen.
README-Generator
Strukturierte Erstellung professioneller GitHub-README.md Dokumentationen mit Badges.
Conventional Commits Assistent
Strukturierte Erstellung standardkonformer Git-Commit-Nachrichten nach Conventional Commits.
SemVer-Versionsrechner
Prüfung und Berechnung semantischer Versionierung (SemVer) nach Regeln (Major, Minor, Patch).
Häufige Fragen & Datenschutz
Kann dieses Tool YAML-Spezifikationen direkt lesen?
Ja. Ein integrierter YAML-Parser verarbeitet sowohl `.yaml`- als auch `.json`-OpenAPI-Vertragsspezifikationen vollständig im Browser.
Wird meine proprietäre API-Spezifikation auf externe Server hochgeladen?
Nein. Das Parsen des Dokuments und das Rendern der Schemata erfolgen ausschließlich im lokalen Arbeitsspeicher Ihres Browsers.