Как да използваме 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 в редактора за схеми по-долу.
- Кликнете на Validate JSON Against This Schema.
- Прегледайте резултатите от валидацията, като всички грешки са подчертани и обяснени.
Отстраняване на проблеми с грешки при валидация на схема
Честите причини за грешки при валидация включват:
- Липсва задължително поле в данните ви.
- Типът на стойност не съвпада със схемата (например низ вместо число).
- Самата схема е невалидна или съдържа печатни грешки.
Заключение
Валидацията с JSON Schema е мощен начин да направите данните си надеждни и без грешки. Опитайте да създадете схема за вашите данни с нашия безплатен Генератор на JSON схеми и я валидирайте на момента!