API-Werkzeuge

OpenAPI-FormatterVerträge gezielt prüfen

JSON oder YAML einfügen, Operationen aufklappen und die Befunde vor dem Export prüfen.

OpenAPI-Formatter

OpenAPI-Quelldokument

Ergebnis

Keine passenden Anfrage-Endpunkte.

0 von 0 angezeigt

Die Spezifikation bleibt in diesem Browser. Keine API-Aufrufe oder Abrufe externer Referenzen.

Ausgabeoptionen

Prüft Dokumentstruktur und häufige Pfadregeln. Endpunktexporte umfassen paths ohne Webhooks und Callbacks. Beispielwerte und echte Antworten werden nicht getestet.

500.000 Eingabezeichen · Tiefe 60 · 50.000 Knoten · 100 Diagnosen · 5 Sekunden Prüfzeit.

Spezifikation einfügen oder Beispiel laden.

Kopie und Download entsprechen der gewählten Ansicht. Der Endpunktexport enthält unabhängig von der Suche die vollständige Liste.

Ein OpenAPI-Formatter hilft bei der Durchsicht generierter Verträge. Lesbare Einrückungen reichen jedoch nicht: Ein Pfad kann einen nicht deklarierten Parameter enthalten, eine Antwort ihre Pflichtbeschreibung vermissen lassen.

Das Feld openapi oder swagger bestimmt die anzuwendenden Regeln. Eine Formatkonvertierung lässt diese Version unverändert und sagt nichts über das Verhalten eines laufenden Dienstes aus.

Warum diesen OpenAPI-Formatter verwenden?

Vom Befund im Dokument zur betroffenen Operation.

Parameter im Zusammenhang lesen

Der OpenAPI-Formatter ordnet Operationen ihren Anfragepfaden zu. Nach dem Aufklappen sehen Sie geerbte Parameter, Antworten, Anfragerumpf sowie Server- und Sicherheitsangaben. Die Suche filtert nur die Ansicht; der Export bleibt vollständig.

Ein strukturiertes Dokument verzweigt in drei Endpunktkarten mit farbigen Methodenmarkierungen.

Ungeprüfte Referenzen erkennen

Interne JSON Pointer werden im selben Dokument gesucht. Fehlende Ziele erzeugen Fehler, rekursive Modelle bleiben verknüpft. Externe Dateien werden als ungeprüft ausgewiesen, sodass ein nicht erreichbares Ziel keinen uneingeschränkt erfolgreichen Status erhält.

Lokale Modellverbindungen neben einer unterbrochenen Referenz mit Warnsymbol.

Drei Entscheidungen vor dem Export

01

Versionsfeld prüfen

Auch eine Spezifikation ohne Anfragepfade kann in 3.1 gültig sein, etwa wenn sie nur components enthält. Ein leerer Baum bedeutet deshalb nicht automatisch einen Fehler.

  • Das Beispiel enthält wiederverwendbare Parameter und ein rekursives Modell.
02

Wirksame Parameter vergleichen

Die Kombination aus Name und Ort entscheidet über die Vererbung. Ein Operationsparameter überschreibt denselben Pfadparameter, statt einen zweiten Eintrag zu erzeugen.

  • Ohne Automatik startet Ctrl/Cmd + Enter die Prüfung.
03

Passende Ansicht exportieren

Die formatierte Spezifikation bleibt editierbar. Die Endpunktansicht liefert das vollständige JSON-Inventar, Markdown eine Dokumentation mit Parametern und Antworten.

  • Änderungen an Eingabe oder Ausgabeoptionen sperren veraltete Exporte.

Struktur, Pfade und Übergabedokumente

OpenAPI validieren

Ein echtes Dokumentschema prüft Swagger 2.0 sowie OpenAPI 3.0 und 3.1. Für 3.1 werden außerdem die Formen standardmäßiger JSON-Schema-2020-12-Schlüsselwörter geprüft, beispielsweise zulässige Typnamen.

Semantische Pfadregeln

Doppelte Operations-IDs und Parameter sowie fehlende Pflichtparameter im Pfad werden gemeldet. servers, parameters und x-Erweiterungen erhöhen die Zahl der HTTP-Operationen nicht.

JSON und YAML konvertieren

Zwei oder vier Leerzeichen vereinheitlichen die Ausgabe. Referenzzeichenketten und Versionsfelder bleiben erhalten. Der aus einem Swagger Editor übernommene Vertrag wird dabei nicht automatisch auf eine neuere Version migriert.

Markdown für die Durchsicht

Der Bericht enthält API-Metadaten, Server und Operationsdetails. Beschreibungen werden maskiert und Codeblöcke sicher begrenzt. Die Vorschau führt kein HTML aus der Spezifikation aus.

Grenzen der Prüfung

Ein Dokument, feste Versionen
Unterstützt werden Swagger 2.0 und OpenAPI 3.0.x/3.1.x. Version 3.2 und andere Spezifikationsfamilien werden zurückgewiesen. Lokale Referenzen beziehen sich ausschließlich auf das eingefügte Dokument.
Externe Ziele bleiben ungeprüft
URLs und relative Dateipfade werden nicht geladen. Ressourcen-IDs, Anker, dynamische Referenzen und eigene Dialekte führen zu einer Warnung über unvollständige Prüfungen. Abhängigkeiten zuerst in einer vertrauenswürdigen Umgebung bündeln.
YAML wird neu serialisiert
Kommentare und Anführungszeichenstile werden nicht erhalten. Ein YAML-1.2-Dokument mit Zeichenkettenschlüsseln ist erforderlich. Anker, Aliase, Merge-Schlüssel, eigene Tags, doppelte Schlüssel und ungenau darstellbare Zahlen stoppen die Verarbeitung.
Anfragepfade statt Laufzeittests
Das Inventar umfasst Operationen unter paths. Webhooks und Callbacks werden strukturell geprüft, aber nicht in das Inventar oder dessen semantische Pfadprüfung aufgenommen. Beispielwerte, echte Antworten und Authentifizierung benötigen eigene Tests.
Begrenzte Verarbeitung
Maximal 500.000 Eingabezeichen, Tiefe 60 und 50.000 Knoten. Bei über 100 Diagnosen, 2.000.000 Ergebniszeichen oder fünf Sekunden Prüfzeit wird abgebrochen. Eine große Spezifikation aufteilen, statt einen abgebrochenen Lauf als Freigabe zu verwenden.

Fragen zum OpenAPI-Formatter

Werden JSON und YAML unterstützt?

Ja, Eingabe und Ausgabe dürfen unterschiedliche Formate haben. Wählen Sie JSON oder YAML und die Einrückung. Bei YAML müssen auch Statuscodes als Zeichenkettenschlüssel geschrieben sein.

Wird die Spezifikation vollständig gegen das Schema geprüft?

Geprüft werden Dokumentstruktur, Standard-Schlüsselwörter, lokale Referenzen und häufige Pfadfehler. Externe Ziele und eigene Dialekte bleiben ausdrücklich ungeprüft. Eine Konformitätsprüfung aller Laufzeitdaten ist das nicht.

Welche Versionen werden erkannt?

Swagger 2.0 und OpenAPI 3.0.x/3.1.x werden anhand ihres Wurzelfelds geprüft. Nicht unterstützte Versionen, etwa 3.2, führen zu einer klaren Meldung.

Wird meine API-Spezifikation hochgeladen?

Nein. Parser und Prüfung laufen im Browser-Worker. Auch in der Spezifikation enthaltene URLs werden nicht aufgerufen. Nach dem Neuladen gibt es keine automatische Wiederherstellung der Eingabe.

Kann ich das Ergebnis herunterladen?

Ja. Die gewählte Ansicht bestimmt, ob eine Spezifikation, das vollständige Endpunktinventar oder Markdown gespeichert wird. Fehler und veraltete Ergebnisse sperren den Export; unvollständige Prüfungen bleiben gekennzeichnet.

Ein konkretes Dokument macht Probleme?

Den nächsten Vertrag durchsehen

Mit dem OpenAPI-Formatter Version und Befunde prüfen und anschließend die benötigte Ansicht weitergeben.

Die Spezifikationsversion bleibt beim Formatieren unverändert.