Converta tipos TypeScript em JSON!

Insira interfaces TypeScript para gerar JSON de exemplo! Compatível com TypeScript interface, type. Útil para documentar APIs e corpos de requisição de teste (mock request body).
TypeScript
Resultado
 

Converta tipos TypeScript em JSON!

Cole declarações TypeScript de interface, type alias, enum ou classe e receba um JSON de exemplo que as satisfaz. Unions de literais, Record, utility types como Pick, Omit e Partial e interfaces encadeadas com extends são todos seguidos e preenchidos.

Use antes de a API existir para preparar dados mock do MSW ou do json-server, para criar props do Storybook ou para mostrar ao time de backend exatamente o formato que você quer que eles mandem.

Como usar

  1. Cole as declarações de tipo de um arquivo como types.ts. export, import e declarações de função podem vir misturados; só as declarações de tipo são lidas.
  2. Inclua os tipos referenciados e os enums para que sejam preenchidos. Nomes de tipo que faltam na entrada viram null.
  3. Não há opções. O primeiro tipo objeto que nenhuma outra declaração referencia vira a raiz, então coloque o que você quer primeiro; um alias que preenche um generic, como type UserPage = Page<User>, tem preferência sobre a própria declaração do generic.
  4. Copie o resultado para o HttpResponse.json(...) de um handler do MSW, uma fixture de teste ou os args do Storybook e depois ajuste os valores.

Exemplo

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 }
Saída (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel é uma union de literais string, então usa o primeiro valor, "email"; o enum string Priority usa o valor do primeiro membro, "low". Record<string, string> vira um objeto com uma única "key", Date | null resolve para o lado não nulo como string ISO, e Pick<Audit, "createdBy"> mantém só a chave escolhida. O opcional locale? também é incluído.

Recursos suportados

  • Primitivos: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (o formato do Date.toJSON()).
  • Tipos literais usam o seu valor, unions pegam o primeiro membro que não é null/undefined, e intersections (A & B) e interface ... extends mesclam as propriedades.
  • Um enum usa o valor do primeiro membro, ou 0 num enum numérico sem inicializadores.
  • Arrays, Array<T> e Set<T> recebem um elemento de exemplo; tuplas recebem um valor por posição; Record<K, V>, Map e index signatures viram {"key": V}.
  • Suporta os utility types Partial, Required, Readonly, NonNullable, Pick e Omit.
  • Métodos e propriedades com tipo de função não existem em JSON e são descartados; em classes, campos static, accessors get/set e campos com @Exclude() são excluídos.
  • Arrays autorreferentes (children: TreeNode[]) são cortados como arrays vazios.

Casos de uso

Respostas mock para MSW ou json-server

Antes de o backend ficar pronto, gere dados mock a partir dos tipos de resposta da API. A UI pode ser feita primeiro, e trocar depois para a API real mantém os mesmos tipos.

Props para Storybook e testes

Crie um objeto padrão a partir do tipo das props de um componente para os args de uma story ou para os dados de render do React Testing Library. Toda propriedade obrigatória está presente, então não há erros de tipo para caçar.

Combinar formatos de request com o backend

Transforme um tipo de request do frontend em JSON e cole num documento de design de API ou numa issue, para que devs de backend que não usam TypeScript leiam a estrutura na hora.

Observações e limitações

  • Propriedades opcionais (?) são sempre incluídas; apague as chaves você mesmo para testar respostas em que elas estão ausentes.
  • Os parâmetros genéricos são substituídos onde o tipo é usado: com type UserPage = Page<User>, items: T[] é preenchido com User, e defaults como <T = string> se aplicam quando nenhum argumento é passado. Conditional types dentro de generics continuam não sendo avaliados.
  • Indexed access types como T["key"], conditional types e template literal types não são avaliados.
  • Um campo de classe inicializado com um único literal (name = "kim", retries = 3) usa esse valor; outros inicializadores como new Date() só indicam o tipo.
  • Código de schema em runtime, como Zod ou io-ts, não é lido; escreva o tipo inferido por z.infer como uma interface simples.
  • Map e Set aparecem como objeto e array, mas o JSON.stringify transforma os dois em {}, então prefira Record ou arrays nos tipos de resposta.

Perguntas frequentes

Está certo Date sair como string?

Sim. O JSON.stringify troca um Date pelo resultado do seu toJSON(), uma string ISO 8601. O lado que recebe continua recebendo uma string, então tipe como string ou faça o parse.

Que valor recebe uma union como status: "active" | "inactive"?

O primeiro literal na ordem de declaração, "active". Reordene a union se preferir mostrar outro valor.

Funciona com classes DTO do NestJS?

Declarações de classe e decorators passam pelo parse, então DTOs anotados com decorators do class-validator são convertidos sem problema, e campos com @Exclude() do class-transformer ficam de fora.

Como vou de JSON para tipos TypeScript?

Use a página JSON → TypeScript para o sentido oposto. Páginas separadas também geram JSON a partir de models TypeORM, Sequelize e Mongoose.