Compare specs
Een aparte pagina (in de sidebar gelinkt als "Compare specs") die twee OpenAPI-documenten via URL ophaalt en rapporteert wat er tussen beide veranderd is: toegevoegde, verwijderde en gewijzigde endpoints, elk gemarkeerd als breaking of informatief.
Gebruik
Klik op Compare specs in de sidebar, plak een URL voor de basis- (oude) spec en een voor de nieuwe spec (het nieuwe veld is vooraf ingevuld met de spec die op dat moment geladen is), en klik dan op Compare. Beide documenten doorlopen exact dezelfde normalizeDocument()-pijplijn als de hoofdviewer, dus is er geen aparte parser om op te vertrouwen.
Wat telt als breaking
| Change | Severity |
|---|---|
| Endpoint verwijderd | Breaking |
| Nieuwe verplichte parameter | Breaking |
| Optionele parameter werd verplicht | Breaking |
| Request body werd verplicht | Breaking |
| Een 2xx-response is verwijderd | Breaking |
| Endpoint toegevoegd | Informatief |
| Parameter verwijderd | Informatief |
| Een niet-2xx-response is verwijderd | Informatief |
| Nieuwe responsestatus gedocumenteerd | Informatief |
Bereik
Dit is bewust beperkt: het vergelijkt aanwezigheid van endpoints, aanwezigheid/verplichtheid van parameters, verplichtheid van de request body, en responsestatuscodes. Het vergelijkt geen schemavormen veld voor veld (bijvoorbeeld een property die stilletjes van string naar number verandert wordt nog niet opgevangen).