Як використовувати 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 та перевірте її в реальному часі!