Как использовать JSON Schema для валидации ваших данных
Что такое JSON Schema?
JSON Schema — это стандартизированный способ описания структуры, обязательных полей и типов значений в ваших JSON-данных. Представьте это как контракт или чертёж, определяющий, каким должен быть корректный JSON. JSON Schema написана на JSON, что делает её удобной как для машинного чтения, так и для редактирования.
Зачем проводить валидацию с помощью схемы?
- Предотвратить ошибки, выявляя неверные или отсутствующие данные до того, как они вызовут проблемы.
- Обеспечить согласованность данных между разными командами, приложениями или API.
- Автоматически создавать документацию на основе схем.
- Помогать редакторам и инструментам предоставлять лучшее автозаполнение и подсказки.
Простой пример: базовая схема
Вот базовый JSON-объект и минимальная схема, которая проверяет его структуру:
{
"name": "Алиса",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
Эта схема гарантирует, что объект должен содержать поле «name» (строка) и поле «age» (число).
Как написать свою кастомную схему
Вы можете задать более сложные правила: ограничивать значения полей, описывать вложенные объекты, задавать минимальные или максимальные числа. Вот пример схемы для проверки массива продуктов:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
Как использовать JSONValidator.dev для валидации схем
- Вставьте ваши JSON-данные в основной редактор.
- Вставьте вашу JSON Schema в редактор схем ниже.
- Нажмите Проверить JSON по этой схеме.
- Просмотрите результаты валидации с выделением и объяснением ошибок.
Устранение ошибок валидации схемы
Основные причины ошибок валидации:
- В данных отсутствует обязательное поле.
- Тип значения не соответствует схеме (например, строка вместо числа).
- Сама схема неверна или содержит опечатки.
Заключение
Валидация с помощью JSON Schema — мощный инструмент для повышения надёжности и качества ваших данных. Попробуйте создать свою схему с помощью нашего бесплатного генератора JSON Schema и протестируйте её онлайн!