OpenAPI / Swagger Betrachter

Interaktive Vorschau und Validierung von OpenAPI (Swagger 2.0 / 3.0) Spezifikationen.

Über OpenAPI / Swagger Betrachter — Ausführliche Anleitung

Kategorie: DevOps & Standards 100 % lokal im Browser

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.

#openapi #swagger #api #docs #rest #yaml #json

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. 1

    Fügen Sie Ihren `swagger.json`- oder `openapi.yaml`-Text ein oder laden Sie die Spezifikationsdatei direkt hoch.

  2. 2

    Durchsuchen Sie die strukturierte API-Dokumentation im interaktiven Viewer.

  3. 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

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.