Руководство по проверке схемы — схема JSON и OpenAPI

Перед выпуском проверяйте полезные данные JSON на соответствие схемам и спецификациям OpenAPI.

Дрейф схемы ломает клиентов молча. CI должен проверять ответы на соответствие JSON Schema и контрактам OpenAPI в каждом выпуске.

Tentaco Schema Studio выводит схемы из образцов и проверяет полезные данные локально во время разработки.

Шаги

Вставьте образец JSON — запустите генератор схем JSON, чтобы получить схему Draft-07.
Отредактируйте обязательные поля и перечисления в соответствии с бизнес-правилами.
Проверяйте ответы, аналогичные производственным, с помощью средства проверки схемы JSON.
Просмотрите полную спецификацию OpenAPI — исправление неработающей $ref и отсутствующих идентификаторов операций.
Добавьте проверенные артефакты схемы в репозиторий для повторного использования конвейера CI.

Interactive preview — runs in your browser.

Продолжайте работать в иммерсивной рабочей среде — режим руководства откроется на боковой панели.

Шаги

Вставьте образец JSON — запустите генератор схем JSON, чтобы получить схему Draft-07.

Отредактируйте обязательные поля и перечисления в соответствии с бизнес-правилами.

Проверяйте ответы, аналогичные производственным, с помощью средства проверки схемы JSON.

Просмотрите полную спецификацию OpenAPI — исправление неработающей $ref и отсутствующих идентификаторов операций.

Добавьте проверенные артефакты схемы в репозиторий для повторного использования конвейера CI.