Генератор JSON-схем

Что вывод делает хорошо

• Типы: string, number, integer, boolean, null, array, object.
• Допустимость null: поле, которое в одном примере равно null, а в другом является строкой, становится ["string", "null"].
• Элементы массива: однородные массивы дают единую схему items; неоднородные массивы дают prefixItems.
• Перечисления (enum): если все наблюдаемые значения принадлежат небольшому набору (настраивается, по умолчанию 10 различных значений), выводится enum.
• Обязательность: при нескольких примерах пересечение ключей становится required; при одном примере все ключи обязательны, если вы не откажетесь от этого.
• Форматы: строки, соответствующие датам ISO-8601, адресам электронной почты или URI, получают выведенный format.

Чего вывод не может знать

• Намерение и пример: пример age: 25 даёт вывод type: integer, но не может знать, что вы также принимаете null. Передавайте несколько примеров, охватывающих крайние случаи.
• Ограничения: minLength, maximum, pattern, их нужно добавлять вручную. Вывод не угадывает пределы по примерам.
• Бизнес-логика: условие «должно быть задано ровно одно из этих трёх полей» требует oneOf, вывести его нельзя.
• Ссылки: генератор выдаёт плоскую схему. Если вы хотите вынести повторяющиеся структуры в $defs, сделайте это после генерации.

Пример вывода

Из одного примера:

{ "name": "Alice", "age": 30, "tags": ["admin", "user"] }

Выведенная схема (draft 2020-12):

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer" },
    "tags": { "type": "array", "items": { "type": "string" } }
  },
  "required": ["name", "age", "tags"]
}

Частые ошибки

• Вывод по одному примеру. Схема будет переобучена, каждое поле становится обязательным, нет допуска null. Всегда подавайте не менее 5–10 разнообразных примеров.
• Использование integer, когда вы имели в виду number. Если хотя бы в одном примере есть дробное число, выведенный тип становится number; если все целые, integer. Для полей, которые могут быть и тем и другим, включите пример с дробным числом.
• Забытые необязательные поля. Поле, присутствующее в 4 из 5 примеров, но отсутствующее в 1, становится необязательным, так и задумано. Если все 5 примеров случайно его содержат, схема пометит его как обязательное, хотя на деле в вашем API оно необязательное.