Saltar al contenido

JSON Schema a TypeScript

Convierte un esquema JSON en tipos TypeScript. Los objetos se convierten en interfaces con propiedades obligatorias y opcionales; $defs y las definiciones se convierten en exportaciones con nombre a las que apunta $ref; enum y const se convierten en tipos literales; anyOf y oneOf se convierten en uniones, y allOf, en una intersección. Las descripciones se conservan como comentarios de documentación.

Restablecer

Preguntas frecuentes

¿Qué borradores de esquema JSON se admiten?

El conversor lee las palabras clave compartidas por draft-07, 2019-09 y 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf y $ref para $defs o definitions. Las palabras clave de validación, como minLength o pattern, no tienen un equivalente en TypeScript y se omiten.

¿Cómo se resuelven las referencias $ref?

Las referencias a #, #/$defs/Name y #/definitions/Name se convierten en el tipo con nombre de esa definición. Cualquier otra referencia, como una a otro archivo o a un URL, se tipa como unknown y se incluye en un comentario al principio del resultado.

¿Cómo se gestiona additionalProperties?

Un objeto sin propiedades y con un esquema additionalProperties se convierte en Record<string, T>. Un objeto con propiedades y un esquema additionalProperties se convierte en la interfaz unida a Record<string, T>. Si additionalProperties es false o falta la palabra clave, no se añade nada, porque los tipos de objeto TypeScript ya describen las claves conocidas.

¿Qué hace nullable?

La palabra clave nullable: true de OpenAPI 3.0 y la extensión x-nullable de Swagger añaden | null al tipo. En JSON Schema, escribe type: ["string", "null"] para obtener string | null.

¿Se admiten esquemas recursivos?

Sí. Una definición que se referencia a sí misma o a otra definición mediante $ref se convierte en un tipo con nombre que hace referencia al otro nombre, y TypeScript lo resuelve sin problemas.

¿Comprueba si mi esquema es válido?

Solo lee el esquema. Las palabras clave desconocidas se ignoran y un esquema sin tipo se convierte en unknown. Usa JSON Schema Validator para validar datos con un esquema.

Acerca de OneClick Pro

OneClick Pro es una colección gratuita de más de 150 herramientas web para las tareas cotidianas: convertir imágenes y unidades, dar formato y validar código, consultar dominios y SEO, y trabajar con texto, fechas y números. Todas las herramientas funcionan sin registro ni suscripción; los datos que introduce solo se utilizan para calcular el resultado y nunca se almacenan. Úsela como una caja de herramientas para tareas puntuales o añada a favoritos las que utiliza a diario.