Compare specs
Eine eigene Seite (in der Sidebar als „Compare specs“ verlinkt), die zwei OpenAPI-Dokumente per URL abruft und meldet, was sich zwischen ihnen geändert hat: hinzugefügte, entfernte und geänderte Endpunkte, jeweils als breaking oder informativ markiert.
Verwendung
Klick in der Sidebar auf Compare specs, füge eine URL für die Basis- (alte) Spec und eine für die neue Spec ein (das Feld für die neue Spec ist vorausgefüllt mit der gerade geladenen Spec) und klick dann auf Compare. Beide Dokumente durchlaufen exakt dieselbe normalizeDocument()-Pipeline, die auch der Hauptviewer nutzt – es gibt also keinen separaten Parser, dem man vertrauen müsste.
Was als Breaking Change gilt
| Change | Severity |
|---|---|
| Endpunkt entfernt | Breaking |
| Neuer Pflichtparameter | Breaking |
| Optionaler Parameter wurde Pflicht | Breaking |
| Request Body wurde Pflicht | Breaking |
| Eine 2xx-Antwort wurde entfernt | Breaking |
| Endpunkt hinzugefügt | Informativ |
| Parameter entfernt | Informativ |
| Eine Nicht-2xx-Antwort wurde entfernt | Informativ |
| Neuer Response-Status dokumentiert | Informativ |
Umfang
Das ist bewusst oberflächlich: Es vergleicht Vorhandensein von Endpunkten, Vorhandensein/Pflichtstatus von Parametern, Pflichtstatus des Request Body und Response-Statuscodes. Es diffed keine Schema-Formen Feld für Feld (z. B. wird eine Property, die still von string zu number wechselt, noch nicht erkannt).