¡Convierte tipos de TypeScript en JSON!

¡Introduce interfaces de TypeScript para generar JSON de ejemplo! Compatible con TypeScript interface, type. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
TypeScript
Resultado
 

¡Convierte tipos de TypeScript en JSON!

Pega declaraciones de TypeScript de tipo interface, alias type, enum o clases y obtén un documento JSON de ejemplo que las cumple. Se siguen y se rellenan las uniones de literales, Record, los utility types como Pick, Omit y Partial, y las interfaces encadenadas con extends.

Úsalo antes de que exista una API para preparar datos mock de MSW o json-server, para crear props de Storybook o para mostrar al equipo de backend exactamente qué forma quieres que envíen.

Cómo usar

  1. Pega declaraciones de tipos de un archivo como types.ts. Puede haber export, import y declaraciones de funciones mezcladas; solo se leen las declaraciones de tipos.
  2. Incluye los tipos referenciados y los enums para que se rellenen. Los nombres de tipos que falten en la entrada pasan a null.
  3. No hay opciones. El primer tipo objeto que ninguna otra declaración referencia pasa a ser la raíz, así que pon primero el que quieras; un alias que concreta un genérico, como type UserPage = Page<User>, tiene preferencia sobre la declaración genérica en sí.
  4. Copia el resultado en el HttpResponse.json(...) de un handler de MSW, en un fixture de pruebas o en los args de Storybook, y luego ajusta los valores.

Ejemplo

Entrada (TypeScript)
type Channel = "email" | "sms" | "push";

enum Priority { Low = "low", High = "high" }

interface Notification {
  id: string;
  channel: Channel;
  priority: Priority;
  recipient: { userId: number; locale?: string };
  payload: Record<string, string>;
  readAt: Date | null;
  meta: Pick<Audit, "createdBy">;
}

interface Audit { createdBy: string; createdAt: Date }
Salida (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel es una unión de literales de cadena, así que toma su primer valor "email"; el enum de cadenas Priority toma el valor de su primer miembro, "low". Record<string, string> pasa a un objeto con una sola "key", Date | null se resuelve al lado no nulo como cadena ISO, y Pick<Audit, "createdBy"> conserva solo la clave elegida. El opcional locale? también se incluye.

Funciones compatibles

  • Primitivos: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (el formato de Date.toJSON()).
  • Los tipos literales usan su valor, las uniones toman el primer miembro que no es null/undefined, y las intersecciones (A & B) e interface ... extends fusionan las propiedades.
  • Un enum usa el valor de su primer miembro, o 0 para un enum numérico sin inicializadores.
  • Los arrays, Array<T> y Set<T> reciben un elemento de ejemplo; las tuplas reciben un valor por posición; Record<K, V>, Map y las index signatures pasan a {"key": V}.
  • Admite los utility types Partial, Required, Readonly, NonNullable, Pick y Omit.
  • Los métodos y las propiedades de tipo función no existen en JSON y se descartan; en las clases, se excluyen los campos static, los accessors get/set y los campos con @Exclude().
  • Los arrays autorreferenciados (children: TreeNode[]) se cortan como arrays vacíos.

Casos de uso

Respuestas mock para MSW o json-server

Antes de que el backend esté listo, genera datos mock a partir de los tipos de respuesta de la API. La UI se puede construir primero, y al pasar después a la API real se mantienen los mismos tipos.

Props para Storybook y tests

Crea un objeto por defecto a partir del tipo de props de un componente para los args de una story o los datos de render de React Testing Library. Todas las propiedades obligatorias están presentes, así que no hay errores de tipos que perseguir.

Acordar formatos de petición con el backend

Convierte un tipo de petición del frontend en JSON y pégalo en un documento de diseño de API o en un issue, para que los desarrolladores de backend que no usan TypeScript puedan leer la estructura de inmediato.

Notas y limitaciones

  • Las propiedades opcionales (?) siempre se incluyen; borra tú las claves para probar respuestas en las que no aparecen.
  • Los parámetros genéricos se sustituyen donde se usa el tipo: con type UserPage = Page<User>, items: T[] se rellena con User, y los valores por defecto como <T = string> se aplican cuando no se pasa argumento. Los tipos condicionales dentro de genéricos siguen sin evaluarse.
  • No se evalúan los indexed access types como T["key"], los tipos condicionales ni los template literal types.
  • Un campo de clase inicializado con un solo literal (name = "kim", retries = 3) usa ese valor; otros inicializadores como new Date() solo sirven de pista del tipo.
  • No se lee código de schemas en runtime como Zod o io-ts; escribe el tipo inferido por z.infer como una interface simple.
  • Map y Set se muestran como objeto y como array, pero JSON.stringify convierte ambos en {}, así que en los tipos de respuesta es preferible usar Record o arrays.

Preguntas frecuentes

¿Es correcto que Date salga como cadena?

Sí. JSON.stringify reemplaza un Date por el resultado de su toJSON(), una cadena ISO 8601. El lado receptor recibe una cadena igualmente, así que tipéala como string o parséala.

¿Qué valor recibe una unión como status: "active" | "inactive"?

El primer literal en orden de declaración, "active". Reordena la unión si prefieres mostrar otro valor.

¿Funciona con clases DTO de NestJS?

Se parsean las declaraciones de clases y los decoradores, así que los DTOs anotados con decoradores de class-validator se convierten sin problemas, y los campos con @Exclude() de class-transformer quedan fuera.

¿Cómo paso de JSON a tipos de TypeScript?

Usa la página JSON → TypeScript para la dirección contraria. Otras páginas también generan JSON a partir de modelos de TypeORM, Sequelize y Mongoose.