Startseite › Entwickler-Tools › JSON zu TypeScript

JSON zu TypeScript

Füge ein JSON-Objekt oder eine API-Antwort ein und erhalte sofort einsetzbare TypeScript-Interfaces oder Typaliase – mit sinnvoll benannten verschachtelten Typen und optionalen Feldern, die aus deinen Daten abgeleitet werden. Die Umwandlung läuft vollständig in deinem Browser.

Zuletzt aktualisiert:

Dein JSON wird lokal in diesem Tab verarbeitet und nie hochgeladen. Tipp: Strg + Eingabe erzeugt die Typen.

Anzeige

Anleitung: JSON zu TypeScript

  1. Füge dein JSON ein (ein Objekt, ein Array oder eine API-Antwort) in das linke Feld oder öffne eine .json-Datei.
  2. Benenne den Wurzeltyp, zum Beispiel User oder ApiResponse.
  3. Wähle die Optionen: interface oder Typalias, export, readonly, optionale Eigenschaften und Array-Stil.
  4. Klicke auf „TypeScript erzeugen“. Mit aktivierter Live-Aktualisierung ändert sich die Ausgabe beim Tippen.
  5. Kopiere oder lade die .ts-Datei herunter und importiere die Typen in dein Projekt.

Beispiel: von JSON zu Interfaces

Bei dieser Antwort, in der der zweite Post ein zusätzliches Feld hat und der erste keines:

{ "id": 1, "name": "Ada", "deletedAt": null,
  "posts": [ { "id": 1, "title": "Hello" },
             { "id": 2, "title": "Draft", "cover": "a.png" } ] }

erzeugt der Generator:

export interface Root {
  id: number;
  name: string;
  deletedAt: null;
  posts: Post[];
}

export interface Post {
  id: number;
  title: string;
  cover?: string;
}

Wie JSON-Werte auf TypeScript abgebildet werden

JSON-WertTypeScript-Typ
"text"string
42, 3.14, -1e3number (TypeScript hat keinen separaten Ganzzahltyp)
true / falseboolean
nullnull oder T | null, wenn andere Beispiele einen Wert haben
{ … }Ein benanntes Interface oder ein benannter Typ
["a", "b"]string[]
[1, "two", null](number | string | null)[]
[]unknown[]
Schlüssel fehlt in einigen Array-ElementenOptionale Eigenschaft key?: T

Tipps für genaue Typen

  • Verwende echte, vielfältige Beispiele. Typen werden aus den eingefügten Daten abgeleitet. Füge ein Array mit mehreren Elementen ein, damit optionale Felder und null-Werte sichtbar werden.
  • Datumswerte bleiben Strings. JSON hat keinen Datumstyp, daher werden ISO-Zeitstempel als string typisiert. Wandle sie nach dem Parsen mit new Date() um.
  • Grenze String-Unions von Hand ein. Ein Feld wie "status": "active" wird als string typisiert; ändere es zu 'active' | 'banned', wenn du die möglichen Werte kennst.
  • Validiere zur Laufzeit. TypeScript-Typen verschwinden nach dem Kompilieren. Ergänze für nicht vertrauenswürdige API-Daten zusätzlich eine Laufzeitvalidierung (zum Beispiel mit einer Schema-Bibliothek).

Musst du das JSON erst aufräumen? Nutze den JSON-Formatierer oder sieh es dir im JSON-Viewer an.

Häufige Fragen

Wie werden optionale Eigenschaften erkannt?

Enthält ein Array mehrere Objekte, führt der Konverter sie zu einem Typ zusammen. Ein Schlüssel, der nur in einigen Elementen vorkommt, wird mit ? als optional markiert, weil deine Daten zeigen, dass er fehlen kann. Bei einem einzelnen Beispielobjekt ist jeder Schlüssel erforderlich, es sei denn, du aktivierst „Alle Eigenschaften optional“.

Wie werden null-Werte typisiert?

Ein null-Wert fügt dem Typ der Eigenschaft null hinzu. Haben andere Beispiele derselben Eigenschaft einen Wert, erhältst du eine Union wie string | null; ist die Eigenschaft immer null, ist ihr Typ einfach null, und du solltest ihn eventuell von Hand durch den echten Typ ersetzen.

Interface oder Typalias: Was sollte ich verwenden?

Beide beschreiben Objektstrukturen gleich gut. Interfaces lassen sich erweitern und zusammenführen und liefern etwas klarere Fehlermeldungen; Typaliase werden für Unions und Mapped Types benötigt. Viele Styleguides verwenden Interfaces für Objektstrukturen, und das ist hier auch die Voreinstellung.

Wie werden verschachtelte Typen benannt?

Jedes verschachtelte Objekt erhält einen PascalCase-Namen aus seinem Schlüssel: profile wird zu Profile, Schlüssel im Stil von avatar_url werden zu AvatarUrl, und Array-Schlüssel werden in den Singular gesetzt, sodass posts zu Post und categories zu Category wird. Kollidierende Namen erhalten eine Nummer, und Objekte mit exakt gleicher Struktur teilen sich einen Typ.

Was passiert mit leeren Arrays und Objekten?

Ein leeres Array wird zu unknown[], weil es kein Element gibt, aus dem gelernt werden kann, und ein leeres Objekt wird zu einem leeren Interface. Füge ein Beispielelement hinzu oder bearbeite den Typ danach.

Werden Schlüssel mit Bindestrichen oder Leerzeichen unterstützt?

Ja. Schlüssel, die keine gültigen JavaScript-Bezeichner sind, wie email-notifications oder 2fa, werden in Anführungszeichen geschrieben, zum Beispiel "email-notifications": boolean.

Wird mein JSON hochgeladen?

Nein. Parsing und Typerzeugung sind reines JavaScript, das auf dieser Seite läuft, daher bleiben API-Antworten mit persönlichen oder geheimen Daten auf deinem Gerät.

Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?

Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.

Ähnliche Tools

Alle Daten- & Dateiformat-Konverter ansehen →