jsonecho

JSON zu TypeScript

Fügen Sie ein JSON-Beispiel ein und erhalten Sie TypeScript-Typen dafür.

Tool wird geladen ...

So verwenden Sie JSON zu TypeScript

  1. Fügen Sie ein repräsentatives JSON-Beispiel ein, idealerweise eines, in dem alle optionalen Felder gefüllt sind.
  2. Legen Sie den Namen des Wurzeltyps fest und entscheiden Sie, ob Sie auch Hilfscode oder nur Typen haben möchten.
  3. Kopieren Sie den erzeugten TypeScript-Code in Ihr Projekt.

Über JSON zu TypeScript

Modellklassen für eine große JSON-Payload von Hand zu schreiben, ist öde, und genau dort schleichen sich Tippfehler ein. Fügen Sie hier ein Beispiel ein, und der Generator ermittelt die Struktur: welche Felder es gibt, welche Objekte, welche Arrays sind und welchen Typ jeder Wert hat. Die Ausgabe sind Interfaces für jedes Objekt. Deaktivieren Sie „Nur Typen“, und eine Convert-Klasse mit Laufzeitprüfungen wird hinzugefügt.

Ein Interface existiert nur zur Kompilierzeit. Wenn Sie eingehende Daten zur Laufzeit prüfen müssen, behalten Sie die Convert-Klasse. Alles läuft in Ihrem Browser, sodass Ihre Beispieldaten auf Ihrem Rechner bleiben.

Den erzeugten Code verwenden

Casten Sie mit const data: Root = JSON.parse(text) oder verwenden Sie zur Validierung das erzeugte Convert.toRoot(text).

Optionale Properties werden mit einem Fragezeichen geschrieben, nullable als string | null.

Häufig gestellte Fragen

Wovon hängt der erzeugte TypeScript-Code ab?

Die Ausgabe sind Interfaces für jedes Objekt. Deaktivieren Sie „Nur Typen“, und eine Convert-Klasse mit Laufzeitprüfungen wird hinzugefügt.

Wie parse ich JSON mit dem Ergebnis?

Casten Sie mit const data: Root = JSON.parse(text) oder verwenden Sie zur Validierung das erzeugte Convert.toRoot(text).

Wie werden optionale und fehlende Felder behandelt?

Optionale Properties werden mit einem Fragezeichen geschrieben, nullable als string | null.

Betrachtet der Generator mehr als einen Datensatz?

Er kennt nur das, was in Ihrem Beispiel steht. Fehlt ein Feld in Ihrem Beispiel, erscheint es nicht in den Typen, und ist ein Wert in Ihrem Beispiel null, ist sein Typ unbekannt. Fügen Sie ein Beispiel ein, in dem möglichst viele Felder gefüllt sind, oder ein Array mit mehreren unterschiedlichen Datensätzen.

Wird mein JSON an einen Server gesendet?

Nein. Der Generator wird beim ersten Gebrauch in Ihren Browser heruntergeladen, etwa 1 MB, und alles läuft lokal.

Mehr in Daten zu Klasse

Alle Tools →