Zum Inhalt springen

JSON Schema zu TypeScript

Wandle ein JSON Schema in TypeScript-Typen um. Objekte werden zu Interfaces mit erforderlichen und optionalen Eigenschaften. $defs und Definitionen werden zu benannten Exporten, auf die $ref verweist. enum und const werden zu Literaltypen, anyOf und oneOf zu Unions und allOf zu einer Schnittmenge. Beschreibungen bleiben als Doc-Kommentare erhalten.

Zurücksetzen

Häufig gestellte Fragen

Welche JSON-Schema-Drafts werden unterstützt?

Der Konverter liest die Schlüsselwörter, die von draft-07, 2019-09 und 2020-12 gemeinsam verwendet werden: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf sowie $ref zu $defs oder definitions. Validierungsschlüsselwörter wie minLength oder pattern haben kein entsprechendes TypeScript-Äquivalent und werden ausgelassen.

Wie werden $ref-Referenzen aufgelöst?

Referenzen auf #, #/$defs/Name und #/definitions/Name werden zum benannten Typ dieser Definition. Jede andere Referenz, etwa auf eine andere Datei oder ein URL, erhält den Typ unknown und wird in einem Kommentar am Anfang der Ausgabe aufgeführt.

Wie wird additionalProperties behandelt?

Ein Objekt ohne properties und mit einem additionalProperties-Schema wird zu Record<string, T>. Ein Objekt mit properties und einem additionalProperties-Schema wird zum Interface, ergänzt um Record<string, T>. additionalProperties false oder ein fehlendes Schlüsselwort fügt nichts hinzu, da TypeScript-Objekttypen die bekannten Schlüssel bereits beschreiben.

Was bewirkt nullable?

Das OpenAPI-3.0-Schlüsselwort nullable: true und die Swagger-Erweiterung x-nullable fügen dem Typ | null hinzu. Im JSON Schema selbst schreibst du type: ["string", "null"], was zu string | null wird.

Werden rekursive Schemas unterstützt?

Ja. Eine Definition, die über $ref auf sich selbst oder eine andere Definition verweist, wird zu einem benannten Typ, der auf den anderen Namen verweist. TypeScript löst das problemlos auf.

Prüft das Tool, ob mein Schema gültig ist?

Das Tool liest nur das Schema. Unbekannte Schlüsselwörter werden ignoriert, und für ein Schema ohne type wird unknown verwendet. Verwende den JSON-Schema-Validator, um Daten anhand eines Schemas zu prüfen.

Über OneClick Pro

OneClick Pro ist eine kostenlose Sammlung mit mehr als 150 Webtools für die tägliche Arbeit: Bilder und Einheiten umwandeln, Code formatieren und validieren, Domains und SEO überprüfen sowie mit Texten, Terminen und Zahlen arbeiten. Jedes Tool funktioniert ohne Registrierung oder Abo. Deine Eingaben werden nur zur Berechnung des Ergebnisses verwendet und niemals gespeichert. Nutze die Sammlung als praktischen Werkzeugkasten für einzelne Aufgaben oder setze ein Lesezeichen für die Tools, die du täglich brauchst.