Как указать обязательное поле в JSON Schema?

Как задать обязательное поле в JSON-схеме?

• JSON Schema — стандарт, описывающий структуру JSON
• Для объявления обязательных свойств применяется ключ "required"
• "required" представляет собой массив имён обязательных свойств объекта
• В "properties" задаются структура и типы данных полей
• Если свойство из "required" отсутствует, JSON не проходит валидацию
• Пример: "required": ["name", "age"] — свойства name и age должны присутствовать
• Так проверяют наличие минимально необходимого набора данных в JSON

Минимальный пример схемы:

{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"required": ["name", "age"]
}

Итог: Обязательность задаётся массивом ключей в свойстве "required": он определяет, какие свойства объекта должны присутствовать.

Развёрнутый ответ

Основной ответ

В JSON Schema обязательность поля задаётся свойством "required". Оно принимает массив строк, содержащих имена свойств, которые должны быть в объекте. По умолчанию все свойства необязательны, поэтому нужные имена необходимо явно перечислить в массиве "required".

Основные моменты

• Свойство "required" применяется только к объектам и размещается на уровне схемы, которая описывает этот объект.
• Например, обязательность поля "name" задаётся записью "required": ["name"].
• Само поле при этом отдельно описывается внутри "properties". Свойство "required" не определяет тип или другие ограничения, а лишь сообщает валидатору о необходимости присутствия поля.
• Если перечислить в "required" имя, отсутствующее в "properties", валидаторы могут выдать ошибку. Поэтому рекомендуется описывать в "properties" все обязательные поля.
• Для вложенных объектов используется тот же принцип: на каждом уровне задаётся собственный "required".

Практический пример

{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"required": ["name"]
}

В этом примере name является обязательным, тогда как age допускается не указывать.

Практический контекст

Такой механизм широко применяют для валидации API по OpenAPI (например, версии 3.0+): JSON Schema формирует контракт и гарантирует передачу клиенту или серверу минимально необходимого набора данных. В React-формах и Node.js (с ajv) проверка позволяет отбрасывать некорректные данные ещё до запуска бизнес-логики.