Guías

Generar esquemas TypeScript, Zod y Pydantic v2 desde JSON

Transforma muestras JSON de APIs en interfaces TypeScript estrictas, validadores Zod en ejecución y clases Pydantic v2 con alias e inferencia opcional.

2 min de lectura

Respuesta rápida: Generar interfaces `TypeScript`, esquemas en tiempo de ejecución `Zod` y modelos Python `Pydantic v2` desde un JSON real detecta claves ausentes y deriva de tipos antes de producción. TxtTo infiere uniones, campos opcionales y objetos anidados localmente sin exponer respuestas internas de API.

Por qué los tipos de compilación no bastan en fronteras de API

Las interfaces TypeScript desaparecen al compilar. Si un webhook externo cambia una clave o devuelve `null` por sorpresa, los tipos estáticos no evitan el fallo en ejecución.

Combinar modelos estáticos TypeScript con validadores en ejecución — Zod en JavaScript/TypeScript y Pydantic v2 en Python — blinda los contratos de datos de punta a punta.

Inferir claves opcionales y tipos unión en TypeScript

Los arreglos de API reales rara vez traen todas las propiedades opcionales en el elemento 0. JSON a TypeScript inspecciona todos los registros del arreglo, fusiona claves y añade `?` a las propiedades ausentes en algunos elementos.

ts
export interface EventItem {
  id: string;
  retries?: number;
  error: string | null;
}

Generar interfaces TypeScript desde JSON

Validación en ejecución y z.infer con Zod

En vez de duplicar interfaces y reglas de validación, JSON a Zod emite validadores anidados `z.object(...)` junto con `export type RootSchema = z.infer<typeof rootSchema>` para mantener tipos y comprobaciones sincronizados.

Generar esquemas de validación Zod

Python Pydantic v2 BaseModel con alias Field

Las APIs web hablan `camelCase`, mientras PEP 8 en Python espera `snake_case`. JSON a Pydantic eleva los modelos anidados, añade `Optional[...]` e incorpora `Field(alias="camelKey")` automáticamente.

python
class RootModel(BaseModel):
    user_id: str = Field(alias="userId")
    is_active: bool = Field(alias="isActive")

Generar modelos Pydantic v2 localmente

Referencias

Preguntas frecuentes

¿Qué ocurre cuando una clave JSON tiene guiones o palabras reservadas de Python?

Los nombres se sanean automáticamente: TypeScript entrecomilla identificadores especiales y Pydantic los mapea a atributos snake_case seguros con Field(alias=...).

¿Conviene activar objetos estrictos en esquemas Zod generados?

Activa z.strictObject() para probar contratos internos cerrados; déjalo desactivado si consumes APIs externas que suelen añadir campos nuevos.

¿Puedo formatear o reparar un JSON sucio antes de generar esquemas?

Sí. Pasa la carga primero por Formateador JSON para limpiar comas finales e inspeccionar el árbol, y continúa directo a JSON a TypeScript.

Formatos relacionados

Comparativas relacionadas

Guías relacionadas