Skip to main content
CheckTown
Konverter

So wandelst du JSON in TypeScript-Interfaces um

Veröffentlicht 6 Min. Lesezeit
In diesem Artikel

Was ist die Konvertierung von JSON zu TypeScript?

Die Konvertierung von JSON zu TypeScript ist der Prozess, bei dem eine JSON-Datenstruktur analysiert und daraus passende TypeScript-Typdefinitionen — Interfaces oder Type-Aliase — erzeugt werden, die die Form dieser Daten beschreiben. Das erspart Entwicklern das manuelle Schreiben von Typdefinitionen für API-Antworten, Konfigurationsdateien und andere JSON-Datenquellen.

Das Typsystem von TypeScript erkennt zur Kompilierzeit Fehler, die andernfalls als Laufzeitfehler auftreten würden. Indem Sie Typen aus echten JSON-Daten generieren, stellen Sie sicher, dass Ihre Typdefinitionen die tatsächliche Datenstruktur präzise abbilden, statt sich auf Dokumentation oder Annahmen zu verlassen.

So funktioniert der Konverter

Unser Konverter analysiert JSON-Strukturen rekursiv und erzeugt saubere TypeScript-Definitionen.

  • Strukturanalyse — durchläuft den JSON-Baum rekursiv, leitet Typen für Primitive ab (string, number, boolean, null) und erkennt verschachtelte Objekte und Arrays
  • Array-Verarbeitung — analysiert die Array-Elemente, um festzustellen, ob sie einen gemeinsamen Typ haben, und erzeugt Union-Typen, wenn sich die Elemente unterscheiden
  • Ausgabeoptionen — wählen Sie zwischen Interface- und Type-Alias-Syntax, schalten Sie export-Schlüsselwörter um, fügen Sie readonly-Modifikatoren hinzu und passen Sie den Namen des Root-Typs an

Kostenlos testen – keine Registrierung erforderlich

JSON in TypeScript konvertieren →

Wann Sie die Konvertierung von JSON zu TypeScript nutzen sollten

Die Typgenerierung aus JSON ist immer dann nützlich, wenn Sie in einem TypeScript-Projekt mit externen Daten arbeiten.

  • API-Integration — fügen Sie eine Beispiel-API-Antwort ein und erhalten Sie sofort Typdefinitionen für die Service-Schicht Ihres Frontends
  • Konfigurationsdateien — generieren Sie Typen für JSON-Konfigurationsdateien, um Autovervollständigung und Validierung in Ihrer IDE zu erhalten
  • Datenbankschemata — konvertieren Sie Beispieldokumente aus MongoDB oder anderen JSON-basierten Datenbanken in TypeScript-Typen für Ihre Datenzugriffsschicht

Häufig gestellte Fragen

Sollte ich ein Interface oder einen Type-Alias verwenden?

Beide funktionieren für die meisten Anwendungsfälle. Interfaces werden für Objektformen im Allgemeinen bevorzugt, da sie Declaration Merging unterstützen und in Fehlermeldungen besser lesbar sind. Type-Aliase sind flexibler und können Unions, Intersections und Mapped Types abbilden. Der Konverter lässt Sie je nach Ihren Projektkonventionen zwischen beiden Formaten wählen.

Wie verarbeitet der Konverter Null-Werte?

Trifft der Konverter im JSON auf einen Null-Wert, erzeugt er einen Union-Typ: zum Beispiel `name: string | null`. Ist ein Feld in den Beispieldaten immer null, wird es als `null` typisiert. Für die genauesten Typen sollten Sie Beispiel-JSON bereitstellen, das für alle Felder auch nicht-null-Werte enthält.

Kann ich verschachtelte JSON-Strukturen konvertieren?

Ja. Der Konverter verarbeitet verschachtelte Objekte rekursiv und erzeugt für jede verschachtelte Struktur ein eigenes benanntes Interface. Ein User-Objekt mit einem address-Feld erzeugt beispielsweise sowohl ein Root-Interface als auch ein Address-Unter-Interface, wodurch der erzeugte Code sauber und wiederverwendbar bleibt.

Verwandte Tools