Генератор JSON Schema
Создайте JSON Schema на основе примера данных JSON. Типы, вложенные объекты, массивы и обязательные свойства будут определены автоматически. Готовую схему можно скопировать или скачать. Работает в браузере.
Ввод
Вывод
Документация
Что делает генератор JSON Schema?
Он создает для вас JSON Schema на основе примера данных. Вставьте образец, например ответ API, файл конфигурации или запись из экспорта базы данных, и получите схему, описывающую его структуру: тип каждого значения, свойства каждого объекта, структуру элементов каждого массива и список обязательных свойств. Это быстрый способ начать работу над документацией API, спецификациями OpenAPI, проверкой форм или контрактами данных. Затем схему можно доработать вручную.
Как пользоваться
- Вставьте или введите образец JSON в поле ввода.
- Выберите редакцию JSON Schema для строки
$schema: Draft 2020-12 или Draft 7. - Укажите, следует ли помечать свойства как обязательные.
- Скопируйте схему или скачайте её как
schema.json.
Если образец не является допустимым JSON, инструмент укажет строку и столбец с ошибкой и выделит её.
Как формируется схема
- Каждому значению назначается тип JSON:
string,boolean,null,object,arrayиintegerдля целых чисел илиnumberдля чисел с дробной частью. Массиву, содержащему целые числа и числа с дробной частью, назначается типnumber, который подходит для обоих вариантов. - Для каждого ключа объекта создается запись
propertiesс соответствующим описанием. Вложенность схемы соответствует вложенности в образце. - Для массива создается одна схема
items, подходящая для всех его элементов. Если элементы — объекты, их свойства объединяются, поэтому для списка записей создается одна схема записи. - Для значений разных типов указываются все типы в списке, например
["string", "null"], или используетсяanyOf, если среди значений есть объекты и значения других типов. - Для пустого массива создается
"type": "array"безitems, поскольку описывать нечего.
Обязательные свойства
Если включен параметр «Помечать свойства как обязательные», ключи каждого объекта перечисляются в required. Для массива объектов свойство считается обязательным, только если оно есть в каждом элементе: например, в списке участников свойство favorite будет необязательным, если оно есть только у некоторых из них. Отключите параметр, чтобы получить схему без списков required.
Что нельзя определить по образцу
Схема, созданная по одному примеру, отражает только то, что показано в этом примере. Она не может определить, какие строковые значения являются адресами электронной почты или датами, какие диапазоны допустимы для чисел и может ли свойство, встретившееся один раз, отсутствовать в других данных. При необходимости вручную добавьте format, minimum, maxLength, enum или pattern, а затем проверьте данные с помощью валидатора JSON Schema.
Как это работает
Инструмент использует genson-js — порт конструктора схем GenSON на JavaScript. Ключевые слова, которые он создает, имеют одинаковое значение в Draft 7 и Draft 2020-12, поэтому выбор редакции меняет только строку $schema. Всё выполняется в браузере: образец никуда не загружается.
Возможности
- Создание JSON Schema по любому образцу JSON
- Автоматическое определение типов, вложенных объектов и массивов
- Объединение элементов массива в одну схему с определением необязательных свойств
- Draft 2020-12 или Draft 7
- Возможность включить или отключить обязательные свойства
- Копирование или скачивание в виде
schema.json - Работа в браузере