01
Richtung festlegen
Die Bewertung gilt für Clients des alten Vertrags. Tauschen zeigt erst eine Vorschau; nach dem Anwenden lassen sich Eingaben und letzter Bericht einmal wiederherstellen.
API-Verträge
OpenAPI-Spezifikationen vergleichenÄnderungen vor dem Release prüfen
Alte und neue Spezifikation getrennt einfügen und den Vergleich bewusst starten.
OpenAPI-Spezifikationen vergleichen
Alte Spezifikation
Neue Spezifikation
Änderungsbericht
Beide Spezifikationen bleiben in diesem Browser; es wird keine API angefragt.
Vergleichsoptionen
Umfang: erfasste Endpunkte, Parameter, Request-Bodys und Antworten. Keine Garantie zur Laufzeit.
Fügen Sie beide Spezifikationen ein.
OpenAPI-Spezifikationen vergleichen ist vor einem Release sinnvoll, wenn bestehende Clients den alten Vertrag bereits nutzen. Ein reiner Textvergleich verrät kaum, ob ein entfernter Endpunkt oder ein neuer Pflichtparameter alte Aufrufe ungültig macht.
Dieser OpenAPI-Diff ordnet Änderungen nach Verbraucherrisiko. Breaking Changes erkennen heißt hier: überprüfbare Kandidaten finden; eine vollständige API-Kompatibilität prüfen kann ein statischer Bericht nicht.
Warum OpenAPI-Spezifikationen vergleichen
Änderungen aus Sicht alter Clients
OpenAPI-Spezifikationen vergleichen bedeutet: alt ist der Ausgangspunkt, neu das Ziel. Ein entferntes Antwortfeld erhält eine andere Einstufung als ein zusätzlicher Endpunkt.
Ausschlüsse nachvollziehbar halten
Ein exakt benannter Pfad wird auf beiden Seiten ausgeschlossen und im Bericht aufgeführt. So bleibt sichtbar, welche Endpunkte die Prüfung bewusst nicht abgedeckt hat.
Drei Entscheidungen vor dem Vergleich
02
Nur vollständige Pfade ausschließen
Tragen Sie etwa /internal/health als vollständigen OpenAPI-Pfad ein, eine Zeile pro Pfad. Regex und JSON Pointer werden nicht ausgewertet.
03
Filter nicht mit Export verwechseln
Die Kategorieauswahl filtert nur sichtbare Treffer. JSON und Markdown enthalten weiterhin den vollständigen aktuellen Bericht samt ausgeschlossenen Pfaden.
Welche Vertragsstellen geprüft werden
Endpunkte und Methoden
Entfernte Methoden oder Pfade gelten als potenziell inkompatibel; neue Endpunkte werden getrennt erfasst. Auch Swagger-Spezifikationen vergleichen lässt sich damit ohne zeilenweisen Diff.
Eingaben und Antworten
Neue Pflichtparameter, Pflichtfelder im Request sowie entfernte Statuscodes und Antwortfelder werden markiert. Einfache Typ- und Enum-Änderungen werden geprüft, soweit lokale Referenzen auflösbar sind.
Bericht mit Belegen
Jeder Befund enthält Methode, Pfad, Regel und Werte davor und danach. Ein veraltetes oder unvollständiges Ergebnis lässt sich nicht versehentlich exportieren.
Grenzen der statischen Prüfung
- Keine URL-Abfrage
- Das Werkzeug verarbeitet eingefügtes JSON oder YAML und fragt weder eine entfernte Spezifikation noch einen echten API-Endpunkt ab.
- Nur exakt gleiche Pfade
- Platzhalter, reguläre Ausdrücke und Callback-Routen werden nicht als Ausschlussmuster interpretiert.
- Unvollständige Referenzen stoppen
- Externe $ref, nicht unterstützte Dialekte, Callbacks und Webhooks verhindern einen neuen Risikobericht; ungeprüfte Stellen werden nicht als sicher gewertet.
- Kein Laufzeitbeweis
- Ein Vertrag beschreibt zulässige Nachrichten, nicht das tatsächliche Serververhalten oder sämtliche generierten SDKs. Testen Sie betroffene Clients zusätzlich.
Fragen zum OpenAPI-Spezifikationen vergleichen
Was versteht das Tool unter einem Breaking Change?
Ein Breaking Change ist hier eine Änderung, durch die ein nach altem Vertrag gültiger Clientaufruf scheitern kann: etwa ein gelöschter Endpunkt oder ein neuer Pflichtparameter. Unsichere Fälle bleiben zur Prüfung offen.
Welche Schema-Formate werden unterstützt?
Akzeptiert werden Swagger 2.0 sowie OpenAPI 3.0 und 3.1 als JSON oder YAML. GraphQL, Postman-Sammlungen und mehrere Dateien mit externen Verweisen gehören nicht dazu.
Wie funktioniert die automatische Schema-Erkennung?
JSON oder YAML wird anhand des Texts erkannt und durch denselben Parser geprüft. Eine gesonderte Formatauswahl ist nicht nötig; Syntaxfehler werden mit Seite und Zeile gemeldet.
Was enthält die Impactanalyse?
Die Impactanalyse listet Methode, Pfad, Regel, Kategorie und Vorher-Nachher-Werte. OpenAPI-Spezifikationen vergleichen liefert damit Belege, aber kein Zertifikat für den Betrieb.
Kann ich YAML mit JSON vergleichen?
Ja, eine alte YAML- und eine neue JSON-Spezifikation können verglichen werden. Inhalt und unterstützte Regeln zählen; Einrückung oder Schlüsselreihenfolge allein erzeugen keinen Befund.
War der Vergleich hilfreich?
Jetzt OpenAPI-Spezifikationen vergleichen
OpenAPI-Spezifikationen vergleichen schafft eine nachvollziehbare Liste möglicher Risiken. Stimmen Sie kritische Befunde mit Clienttests ab.