Генератор схем JSON
Создайте схему JSON на основе примера JSON. Генератор определяет типы, обязательные свойства, схемы элементов массивов и распространённые форматы строк, такие как дата и время, email, 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 уровней. Пример анализируется только для этого запроса и не сохраняется.