Cómo usar: JSON Schema a TypeScript
- Pega tu JSON Schema, o un objeto
components.schemasde OpenAPI, en el panel izquierdo. - Define el nombre del tipo raíz y si quieres usar
interfaceotype. - Los tipos de TypeScript se actualizan mientras escribes; las definiciones de
$defsodefinitionsse convierten en tipos con nombre propio. - Copia el código en un archivo
.tso.d.ts.
Cómo se traduce JSON Schema a TypeScript
| JSON Schema | TypeScript |
|---|---|
"type": "string" / number, integer / boolean / null | string / number / boolean / null |
properties + required | interface con prop y prop? opcional |
enum, const | unión de literales: "draft" | "published" |
items, prefixItems | T[], tuplas [A, B] |
additionalProperties (schema) | índice de firma [key: string]: T |
oneOf / anyOf / allOf | A | B / A | B / A & B |
$ref: "#/$defs/User" | el tipo con nombre User |
"type": ["string", "null"] | string | null |
Las palabras clave solo de validación, como minLength, pattern o format, no tienen equivalente en TypeScript; si JSDoc está activado, se añaden al comentario JSDoc. Las URLs de $ref externas se tipan como unknown.
¿Partes de datos de ejemplo en lugar de un schema? Usa JSON a TypeScript. Para comprobar datos contra un schema, usa el validador de JSON Schema.
También se busca como: json schema a ts, generar typescript desde json schema, interface json schema, convertir json schema a typescript online, openapi schema a typescript, tipos json schema, conversor json schema.
Herramientas que combinan con: JSON Schema a TypeScript
- JSON a JSON Schema — Pega uno o varios ejemplos de JSON y obtén un JSON Schema que los describe: objetos anidados, arrays de objetos fusionados en un único esquema de elemento, campos required (claves presentes en todos los ejemplos), formatos detectados como email, date-time, URI y UUID, enums opcionales, y salida en draft 2020-12 o draft-07.
- De JSON a tipos — Pega una respuesta de la API y obtén modelos listos para usar en 8 lenguajes: TypeScript, Python (dataclass, TypedDict o Pydantic), Go, Java, C#, Kotlin, Swift y Rust.
- Formateador JSON — Pega el código JSON para formatearlo, minimizarlo o validarlo.
- Validador OpenAPI / Swagger — Pega una especificación de API para comprobarla contra el esquema oficial de OpenAPI, detectar referencias rotas y parámetros de ruta inconsistentes, y ver todos los endpoints de un vistazo.