Compare specs
Dedykowana strona (linkowana z panelu bocznego jako „Compare specs”), która pobiera dwa dokumenty OpenAPI po URL-u i raportuje, co się między nimi zmieniło: dodane, usunięte i zmienione endpointy, każdy oznaczony jako breaking albo informacyjny.
Użycie
Kliknij Compare specs w panelu bocznym, wklej URL dla bazowej (starej) specyfikacji i jeden dla nowej (pole nowej jest wstępnie wypełnione aktualnie załadowaną specyfikacją), potem kliknij Compare. Oba dokumenty przechodzą przez dokładnie ten sam pipeline normalizeDocument(), którego używa główny viewer, więc nie ma osobnego parsera do zaufania.
Co liczy się jako breaking
| Change | Severity |
|---|---|
| Endpoint usunięty | Breaking |
| Nowy wymagany parametr | Breaking |
| Parametr opcjonalny stał się wymagany | Breaking |
| Body żądania stało się wymagane | Breaking |
| Usunięto odpowiedź 2xx | Breaking |
| Endpoint dodany | Informacyjne |
| Parametr usunięty | Informacyjne |
| Usunięto odpowiedź inną niż 2xx | Informacyjne |
| Udokumentowano nowy status odpowiedzi | Informacyjne |
Zakres
To celowo płytkie porównanie: sprawdza obecność endpointu, obecność/wymagalność parametru, wymagalność body żądania oraz kody statusu odpowiedzi. Nie porównuje kształtów schematów pole po polu (np. właściwość cicho zmieniająca się z string na number nie jest jeszcze wychwytywana).