JSON-skema til TypeScript
Konvertér et JSON-skema til TypeScript-typer. Objekter bliver til grænseflader med påkrævede og valgfrie egenskaber, $defs og definitioner bliver til navngivne eksporter, som $ref henviser til, enum og const bliver til literal-typer, anyOf og oneOf bliver til unioner, og allOf bliver til et skæringspunkt. Beskrivelser bevares som dokumentationskommentarer.
Ofte stillede spørgsmål
Hvilke JSON Schema-drafts understøttes?
Konverteren læser de nøgleord, der deles af draft-07, 2019-09 og 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf samt $ref til $defs eller definitions. Valideringsnøgleord som minLength eller pattern har ingen tilsvarende TypeScript og udelades.
Hvordan håndteres $ref-referencer?
Referencer til #, #/$defs/Name og #/definitions/Name bliver til den navngivne type for den pågældende definition. Enhver anden reference, f.eks. til en anden fil eller en URL, angives som unknown og oplistes i en kommentar øverst i outputtet.
Hvordan håndteres additionalProperties?
Et objekt uden properties og med et additionalProperties-skema bliver til Record<string, T>. Et objekt med properties og et additionalProperties-skema bliver til grænsefladen sammenføjet med Record<string, T>. additionalProperties false eller et manglende nøgleord tilføjer intet, fordi TypeScript-objekttyper allerede beskriver de kendte nøgler.
Hvad gør nullable?
OpenAPI 3.0-nøgleordet nullable: true og Swagger-udvidelsen x-nullable føjer | null til typen. I selve JSON-skemaet skal du skrive type: ["string", "null"], som bliver til string | null.
Understøttes rekursive skemaer?
Ja. En definition, der henviser til sig selv eller en anden definition via $ref, bliver til en navngiven type, der henviser til det andet navn, som TypeScript håndterer uden problemer.
Kontrollerer værktøjet, om mit skema er gyldigt?
Værktøjet læser kun skemaet. Ukendte nøgleord ignoreres, og et skema uden en type bliver til unknown. Brug JSON-skemavalidatoren til at kontrollere data op imod et skema.