Валідатор схем JSON
Ласкаво просимо до нашого валідатора схем JSON. Переконайтеся, що ваші JSON-дані відповідають попередньо визначеним схемам для забезпечення цілісності та узгодженості даних. Цей інструмент необхідний розробникам, аналітикам даних і всім, хто працює з даними JSON.
Як валідатор схеми JSON перевіряє дані
Валідатор схеми JSON перевіряє документ JSON на відповідність схемі JSON і повідомляє, чи він дійсний, або недійсний, із зазначенням розташування кожної проблеми у вигляді вказівника JSON, наприклад /age. Якщо в схемі немає ключового слова $schema, вона вважається схемою draft-07.
Для перевірки використовується бібліотека схем JSON від Opis. Обидва вхідні документи спершу проходять той самий етап виправлення, що й JSON Repair, тому кінцева кома не перешкоджає перевірці. $ref на схему на іншому сервері не завантажується та позначається як невирішене посилання.
Приклади з розв’язанням
Дані, що відповідають схемі
Обидві обов’язкові властивості наявні, а age — невід’ємне ціле число.
- Схема
{ "type": "object", "required": ["name", "age"], "properties": { "name": {"type": "string"}, "age": {"type": "integer", "minimum": 0} } }- JSON
{"name": "Ada", "age": 36}- Результат
✅ Дійсний
Значення нижче мінімуму
Та сама схема, що й вище. Помилка вказує на /age.
- JSON
{"name": "Ada", "age": -1}- Результат
❌ Недійсний
{ "/age": [ "Number must be greater than or equal to 0" ] }
Відсутня обов’язкова властивість
Та сама схема, що й вище. Про відсутню властивість повідомляється для об’єкта, у якому вона має бути; тут це кореневий об’єкт, позначений як /.
- JSON
{"age": 36}- Результат
❌ Недійсний
{ "/": [ "The required properties (name) are missing" ] }
Поширені ключові слова draft-07
Ці ключові слова охоплюють більшість типових схем. Усі вони визначені у специфікації JSON Schema Validation для draft-07.
| Ключове слово | Що перевіряє | Приклад |
|---|---|---|
type | Тип JSON: рядок, число, ціле число, логічне значення, об’єкт, масив або null. | {"type": "string"} |
required | Властивості, які мають бути в об’єкті. | {"required": ["id"]} |
properties | Схема для кожної іменованої властивості. | {"properties": {"id": {"type": "integer"}}} |
additionalProperties | Чи дозволені властивості, не перелічені в properties. | {"additionalProperties": false} |
enum | Значення має дорівнювати одному з перелічених значень. | {"enum": ["draft", "published"]} |
minimum, maximum | Включні нижня та верхня межі для чисел. | {"minimum": 0, "maximum": 100} |
minLength, maxLength | Межі кількості символів у рядку. | {"maxLength": 60} |
pattern | Регулярний вираз, якому має відповідати рядок. | {"pattern": "^[a-z-]+$"} |
items | Схема, якій має відповідати кожен елемент масиву. | {"items": {"type": "string"}} |
Як використовувати валідатор схем JSON
- Крок 1: Введіть дані у форматі JSON у поле введення.
- Крок 2: Надайте відповідну JSON-схему.
- Крок 3: Натисніть кнопку "Перевірити схему JSON", щоб звірити дані зі схемою.
Переваги використання нашого валідатора схем JSON
- Забезпечення цілісності даних: Перевіряє дані JSON на відповідність схемам, щоб підтримувати якість даних.
- Узгодженість даних: Забезпечує відповідність ваших даних очікуваним структурам у різних додатках.
- Зручний для користувача: простий інтерфейс для легкої перевірки.
Поширені запитання
Як перевірити JSON на відповідність схемі?
Щоб перевірити JSON на відповідність схемі, введіть дані JSON у поле введення і надайте відповідну схему JSON. Натисніть кнопку Перевірити JSON, і інструмент перевірить дані за схемою, відобразивши будь-які помилки перевірки.
Що таке схема JSON?
Схема JSON - це формат для визначення структури, вмісту та обмежень даних JSON. Вона визначає очікувані типи даних, обов'язкові поля та інші правила перевірки, щоб гарантувати, що дані JSON правильно відформатовані та узгоджені.
Чому важлива валідація JSON-схеми?
Валідація JSON-схем має вирішальне значення для забезпечення цілісності та узгодженості даних у додатках. Вона допомагає виявити помилки на ранніх стадіях розробки, запобігає пошкодженню даних і гарантує, що API та інші системи обробляють дані коректно.
Чи можна валідувати складні структури JSON?
Так, JSON Schema Validator може обробляти складні структури JSON, включаючи вкладені об'єкти, масиви і різні типи даних, забезпечуючи ретельну перевірку вашої схеми.
Що станеться, якщо мої JSON-дані не збігаються зі схемою?
Якщо ваші JSON-дані не відповідають схемі, валідатор відобразить детальні повідомлення про помилки із зазначенням проблем. Це допоможе вам виявити і виправити помилки, щоб ваші дані відповідали очікуваній структурі.
Яка версія схеми JSON підтримується?
Валідатор зазвичай підтримує останні версії JSON Schema (Draft 4, Draft 6, Draft 7, 2019-09, 2020-12). Кожна версія містить розширені функції та покращені можливості валідації, забезпечуючи сумісність із сучасними визначеннями схем.
Як створити схему JSON?
Визначте очікувану структуру JSON за допомогою синтаксису JSON Schema: вкажіть необхідні властивості, типи даних (рядок, число, логічний, масив, об'єкт), обмеження (min/max, шаблони, перерахування) та вкладеність. Використовуйте генератори схем або напишіть вручну, а потім протестуйте з реальними даними.
Чи замінює валідація схеми модульне тестування?
Валідація схеми доповнює, але не замінює модульні тести. Вона перевіряє структуру і типи даних, але не бізнес-логіку, обчислення або робочі процеси. Використовуйте валідацію схеми для контрактів API та цілісності даних; юніт-тести - для логіки та поведінки програми.
Як валідація допомагає розробці API?
Валідація схеми гарантує, що запити та відповіді API відповідають очікуваним форматам, відловлює неправильні дані перед обробкою, чітко документує контракти API, дозволяє автоматично генерувати документацію, підтримує версії API та підвищує надійність інтеграції завдяки перевірці кордонів.
Які типові помилки валідації?
Поширені помилки включають невідповідність типів (рядок vs число), відсутність необхідних властивостей, неочікувані додаткові властивості, значення поза допустимими переліками, невідповідність шаблонів, порушення довжини масиву, порушення діапазону чисел, а також помилки перевірки вкладених об'єктів з конкретними деталями помилок.
Чи можуть схеми перевіряти вхідні дані форми?
Так, JSON-схеми чудово підходять для валідації форм. Визначте типи полів, обов'язкові поля, правила валідації, мінімальні/максимальні значення та шаблони в схемах. Багато бібліотек форм підтримують JSON-схеми для декларативної валідації, що скорочує код ручної валідації.
Як перевірити масиви за допомогою схем?
Визначайте схеми масивів за допомогою типу: 'array', визначайте схеми елементів за допомогою 'items', встановлюйте обмеження типу minItems/maxItems, забезпечуйте унікальність значень за допомогою uniqueItems та перевіряйте вкладені структури масивів. Валідатор гарантує, що всі елементи масиву відповідають вимогам схеми.
Що таке розробка за принципом "спочатку схеми"?
Розробка "спочатку схеми" визначає схеми даних перед реалізацією коду. Створюйте JSON-схеми, що документують очікувані структури даних, використовуйте їх для перевірки всіх входів/виходів, генеруйте код на основі схем і переконайтеся, що всі компоненти використовують узгоджені контракти на передачу даних, що зменшує проблеми інтеграції.
Чи можуть схеми перевіряти умовні вимоги?
Так, JSON Schema підтримує умовну перевірку за допомогою ключових слів if/then/else, залежностей, oneOf, anyOf та allOf. Вони дозволяють створювати складну логіку перевірки, де певні властивості вимагаються лише тоді, коли виконуються певні умови.