JSON para Zod
Gere schemas Zod a partir de uma amostra JSON. Objetos aninhados viram schemas exportados próprios, chaves ausentes em alguns itens de um array se tornam .optional(), valores nulos se tornam .nullable() e valores de tipos mistos se tornam z.union. Cada schema também recebe um alias de tipo z.infer, para que você tenha validação em tempo de execução e tipos TypeScript a partir de uma única colagem.
Perguntas frequentes
Como os objetos aninhados são nomeados?
Cada objeto aninhado vira seu próprio tipo Zod, nomeado com base na chave que o contém em PascalCase; assim, address vira Address. Objetos dentro de arrays recebem a forma singular da chave do array; por exemplo, users vira User. Objetos com campos exatamente iguais compartilham o mesmo tipo.
Quando um campo é opcional?
Quando um array contém vários objetos e uma chave está ausente em alguns deles, esse campo é opcional: o schema adiciona .optional(). Uma chave presente em todas as amostras é obrigatória. Um único objeto não tem outros com que ser comparado, então todas as suas chaves são obrigatórias.
Como os valores nulos são tratados?
Uma chave que é nula em algumas amostras e tem valor em outras se torna o tipo seguido de .nullable(). Se uma chave for sempre nula, a ferramenta não consegue determinar seu tipo real, então ela se torna z.null(); cole uma amostra com um valor real para obter um tipo preciso.
Quais tipos numéricos são usados?
Números inteiros se tornam z.number().int(), e números fracionários se tornam z.number(). Quando o mesmo campo contém ambos, o schema usa z.number(), pois todo inteiro também é um número válido.
O que acontece com chaves que não são nomes válidos?
Chaves que não são identificadores JavaScript válidos, como first-name, são escritas entre aspas no z.object, para que o schema continue correspondendo exatamente às chaves JSON originais.
Meu JSON é enviado ou armazenado?
O JSON é enviado ao servidor apenas para gerar o código desta solicitação e não é armazenado. O gerador lê somente a estrutura e os tipos de valor da sua amostra; por isso, você pode substituir valores confidenciais por marcadores do mesmo tipo antes de colá-la.