Схема JSON в TypeScript
Преобразуйте схему JSON в типы TypeScript. Объекты становятся интерфейсами с обязательными и необязательными свойствами; $defs и определения становятся именованными экспортами, на которые ссылается $ref; enum и const становятся литеральными типами, anyOf и oneOf — объединениями, а allOf — пересечением. Описания сохраняются в комментариях документации.
Часто задаваемые вопросы
Какие черновые версии схем JSON поддерживаются?
Конвертер читает ключевые слова, общие для draft-07, 2019-09 и 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf, а также $ref к $defs или definitions. У ключевых слов проверки, таких как minLength и pattern, нет эквивалента в TypeScript, поэтому они пропускаются.
Как разрешаются ссылки $ref?
Ссылки на #, #/$defs/Name и #/definitions/Name становятся именованным типом соответствующего определения. Любая другая ссылка, например на другой файл или URL, получает тип unknown и указывается в комментарии в начале результата.
Как обрабатывается additionalProperties?
Объект без свойств, но со схемой additionalProperties, становится Record<string, T>. Объект со свойствами и схемой additionalProperties становится интерфейсом, объединенным с Record<string, T>. Значение additionalProperties false или отсутствие этого ключевого слова ничего не добавляет, поскольку типы объектов TypeScript уже описывают известные ключи.
Что делает nullable?
Ключевое слово OpenAPI 3.0 nullable: true и расширение Swagger x-nullable добавляют | null к типу. В самой схеме JSON укажите type: ["string", "null"] — результатом будет string | null.
Поддерживаются ли рекурсивные схемы?
Да. Определение, которое ссылается на себя или другое определение через $ref, становится именованным типом, ссылающимся на другое имя; TypeScript разрешает такую ссылку без проблем.
Проверяет ли инструмент корректность моей схемы?
Инструмент только читает схему. Неизвестные ключевые слова игнорируются, а схема без типа становится unknown. Чтобы проверить данные по схеме, используйте Валидатор схемы JSON.