Compare specs
Una pagina dedicata (raggiungibile dalla sidebar come "Compare specs") che recupera due documenti OpenAPI via URL e riporta cosa è cambiato tra loro: endpoint aggiunti, rimossi e modificati, ciascuno marcato come breaking o informativo.
Utilizzo
Clicca Compare specs nella sidebar, incolla un URL per la spec base (vecchia) e uno per la nuova (il campo new viene precompilato con la spec attualmente caricata), poi clicca Compare. Entrambi i documenti passano esattamente per la stessa pipeline normalizeDocument() usata dal visualizzatore principale, quindi non c'è un parser separato di cui fidarsi.
Cosa conta come breaking
| Change | Severity |
|---|---|
| Endpoint rimosso | Breaking |
| Nuovo parametro obbligatorio | Breaking |
| Parametro opzionale diventato obbligatorio | Breaking |
| Il request body è diventato obbligatorio | Breaking |
| Una risposta 2xx è stata rimossa | Breaking |
| Endpoint aggiunto | Informativo |
| Parametro rimosso | Informativo |
| Una risposta non-2xx è stata rimossa | Informativo |
| Nuovo status di risposta documentato | Informativo |
Ambito
È deliberatamente superficiale: confronta la presenza degli endpoint, la presenza/obbligatorietà dei parametri, l'obbligatorietà del request body e i codici di stato delle risposte. Non confronta la forma degli schemi campo per campo (ad es. una proprietà che passa silenziosamente da string a number non viene ancora rilevata).