Генератор схем JSON
Створіть схему JSON на основі зразка JSON. Генератор визначає типи, обов’язкові властивості, схеми елементів масивів і поширені формати рядків, як-от дата й час, електронна адреса, uri та uuid, а також створює схему для чернетки 2020-12, 2019-09 або draft-07. Її можна використовувати для перевірки запитів, документування API або створення форм.
Поширені запитання
Які чернетки схем JSON підтримуються?
Draft 2020-12 — поточна версія, яку використовує OpenAPI 3.1, а також draft 2019-09 і draft-07, на які досі розраховують багато старіших засобів перевірки та інструментів. Вибір визначає $schema URL; ключові слова, які створює генератор, мають однакове значення в усіх трьох версіях.
Як визначаються обов’язкові властивості?
Властивість додається до списку required, якщо вона є в кожному зразку цього об’єкта. У масиві об’єктів ключ, якого бракує в деяких елементах, не включається до required. Вимкніть цей параметр, щоб створити схему без списків required.
Які формати рядків розпізнаються?
date-time, date, time, email, uri, uuid та ipv4. Формат додається, лише якщо йому відповідають усі значення цієї властивості у зразках; одне значення у вільній формі залишає властивість звичайним рядком. Вимкніть розпізнавання, якщо не хочете додавати ключові слова формату.
Чи розрізняє схема цілі та десяткові числа?
Так. Якщо всі зразки властивості — цілі числа, її типом буде integer. Щойно в одному зі зразків з’явиться дробова частина, тип стане number, який також допускає цілі числа.
Як описуються масиви?
Масив отримує тип array і схему елементів, створену на основі всіх його елементів разом. Об’єкти в масиві об’єднуються, тож схема елементів містить усі ключі, що трапляються в будь-якому елементі; до required входять лише ключі, наявні в усіх елементах.
Що відбувається зі змішаними типами?
Якщо властивість містить прості значення різних типів, наприклад рядок в одному елементі й null в іншому, схема перелічує їх як масив типів, наприклад ["string", "null"]. Якщо з іншими типами змішані об’єкти або масиви, генератор використовує anyOf з окремою схемою для кожного типу.
Чи додаються additionalProperties або обмеження?
Ні. За зразком неможливо визначити, які додаткові ключі заборонені та якими є справжні мінімальне й максимальне значення, тому генератор не додає additionalProperties, minLength, maximum та подібні ключові слова. Додайте їх вручну, якщо цього потребують ваші дані.
Чи можна перевірити дані за результатом?
Так. Вставте схему й дані у Валідатор схем JSON або скористайтеся бібліотекою, наприклад Ajv. Спершу перевірте схему: вона відповідає вашому зразку, тому якщо поле може бути відсутнім або мати значення null у реальних даних, але не у зразку, схему потрібно трохи відредагувати.
Чи можна використовувати схему в OpenAPI?
OpenAPI 3.1 використовує JSON Schema 2020-12 безпосередньо, тож згенеровану схему можна розмістити в components/schemas після видалення рядка $schema. OpenAPI 3.0 використовує старішу підмножину; у ній замініть масиви типів на nullable.
Який максимальний розмір вхідних даних?
До 1,000,000 символів JSON, вкладення до 64 рівнів. Зразок аналізується лише для цього запиту й не зберігається.