Compare specs
Отдельная страница (в боковой панели она называется «Compare specs»), которая забирает два документа OpenAPI по URL и показывает, что между ними изменилось: добавленные, удалённые и изменённые эндпоинты, каждый с пометкой «ломающее» или «информационное».
Использование
Нажмите Compare specs в боковой панели, вставьте URL базовой (старой) спецификации и новой (поле для новой заранее заполнено той спецификацией, что загружена сейчас), затем нажмите Compare. Оба документа проходят через тот же самый конвейер normalizeDocument(), которым пользуется основной просмотрщик, так что отдельному парсеру доверять не приходится.
Что считается ломающим
| Change | Severity |
|---|---|
| Эндпоинт удалён | Ломающее |
| Новый обязательный параметр | Ломающее |
| Необязательный параметр стал обязательным | Ломающее |
| Тело запроса стало обязательным | Ломающее |
| Удалён ответ 2xx | Ломающее |
| Эндпоинт добавлен | Информационное |
| Параметр удалён | Информационное |
| Удалён ответ не из 2xx | Информационное |
| Задокументирован новый код ответа | Информационное |
Границы проверки
Сравнение намеренно неглубокое: проверяются наличие эндпоинтов, наличие и обязательность параметров, обязательность тела запроса и коды ответов. Схемы по полям не сравниваются (скажем, смену свойства с string на number без прочих изменений здесь пока не поймать).