Валидатор JSON Schema

Поддерживаемые ключевые слова

Ядро: type, enum, const, multipleOf, maximum, minimum, exclusiveMaximum, exclusiveMinimum, maxLength, minLength, pattern, maxItems, minItems, uniqueItems, maxContains, minContains, maxProperties, minProperties, required, dependentRequired.

Композиция: allOf, anyOf, oneOf, not.

Аппликаторы: properties, patternProperties, additionalProperties, items, prefixItems, contains, propertyNames.

Условные: if, then, else, dependentSchemas.

Ссылки: $ref, $defs, $id, $anchor.

Форматы (с валидацией при включении): date-time, date, time, duration, email, hostname, ipv4, ipv6, uri, uuid, regex.

Вывод ошибок

FAIL  /user/email        format            "not-an-email" is not a valid "email"
FAIL  /user/age          minimum           -3 is less than the minimum 0
FAIL  /orders/0/total    type              "42" is not of type "number"
FAIL  /                  required          missing required property "shippingAddress"

Каждая ошибка включает путь и неудавшееся ключевое слово, что позволяет быстро найти ее в вашем редакторе.

Различия draft, которые кусаются

Задайте правильный draft; валидация схемы draft-04 как 2020-12 неверно истолкует id и некоторые другие тонкости.

Типичные рабочие процессы

• Тестирование контракта API: перед деплоем прогоните сгенерированную/обновленную схему OpenAPI по реальным примерам ответов.
• Усиление конфигурации: валидируйте каждый YAML/JSON-конфиг в CI по схеме перед слиянием.
• Прием данных: отклоняйте полезные нагрузки, не соответствующие ожидаемой форме, заранее, с понятным сообщением об ошибке.

Частые ошибки

• Забывание принудительной проверки format. По умолчанию большинство валидаторов трактуют неизвестные форматы как только аннотацию. Включите строгую проверку формата, чтобы действительно отклонять некорректные email и даты.
• Чрезмерное использование oneOf. Если две ветви oneOf пересекаются, документ не пройдет (он должен совпадать ровно с одной). Используйте anyOf или паттерны дискриминатора.
• Тесные схемы с additionalProperties: false. Добавление нового опционального поля становится ломающим изменением. Опускайте это, если только вам действительно не нужен закрытый объект.