Схема JSON у TypeScript
Перетворюйте схему JSON на типи TypeScript. Об’єкти стають інтерфейсами з обов’язковими й необов’язковими властивостями; $defs та definitions стають іменованими експортами, на які посилається $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?
Ключове слово nullable: true в OpenAPI 3.0 та розширення Swagger x-nullable додають | null до типу. У самій схемі JSON запишіть type: ["string", "null"], що перетворюється на string | null.
Чи підтримуються рекурсивні схеми?
Так. Визначення, яке посилається на себе або на інше визначення через $ref, стає іменованим типом, що посилається на іншу назву; TypeScript обробляє це без проблем.
Чи перевіряє інструмент, що моя схема дійсна?
Інструмент лише читає схему. Невідомі ключові слова ігноруються, а схема без типу стає unknown. Щоб перевірити дані за схемою, скористайтеся валідатором схеми JSON.