JSON Schema para TypeScript
Converta um Schema JSON em tipos TypeScript. Objetos passam a ser interfaces com propriedades obrigatórias e opcionais; $defs e definições passam a ser exportações nomeadas para as quais $ref aponta; enum e const passam a ser tipos literais, anyOf e oneOf passam a ser uniões, e allOf passa a ser uma interseção. As descrições são mantidas como comentários de documentação.
Perguntas frequentes
Quais rascunhos do Schema de JSON são compatíveis?
O conversor lê as palavras-chave compartilhadas pelo draft-07, 2019-09 e 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf e $ref para $defs ou definitions. Palavras-chave de validação, como minLength ou pattern, não têm equivalente em TypeScript e são omitidas.
Como são resolvidas as referências $ref?
Referências a #, #/$defs/Name e #/definitions/Name passam a ser o tipo nomeado daquela definição. Qualquer outra referência, como uma para outro arquivo ou para um URL, é tipada como unknown e listada em um comentário no início da saída.
Como additionalProperties é tratado?
Um objeto sem propriedades e com um schema additionalProperties passa a ser Record<string, T>. Um objeto com propriedades e um schema additionalProperties passa a ser a interface combinada com Record<string, T>. additionalProperties false ou a ausência dessa palavra-chave não adiciona nada, pois os tipos de objeto TypeScript já descrevem as chaves conhecidas.
O que nullable faz?
A palavra-chave nullable: true do OpenAPI 3.0 e a extensão x-nullable do Swagger adicionam | null ao tipo. No próprio Schema JSON, escreva type: ["string", "null"], que passa a ser string | null.
Schemas recursivos são compatíveis?
Sim. Uma definição que se refere a si mesma ou a outra definição por meio de $ref passa a ser um tipo nomeado que se refere ao outro nome, e TypeScript o resolve sem problemas.
Ele verifica se meu schema é válido?
Ele apenas lê o schema. Palavras-chave desconhecidas são ignoradas, e um schema sem type passa a ser unknown. Use o Validador de Schema JSON para verificar dados em relação a um schema.