JSON zu TypeScript

Erstellen Sie ein TypeScript-Interface aus einem JSON-Beispiel.

Eingabe
Ergebnis

Anwendungsbeispiele

Schnell einen Typ für eine API-Antwort entwerfen

Fügen Sie ein Beispiel einer JSON-Antwort von Ihrem Server ein und erhalten Sie einen TypeScript-Interface-Entwurf, den Sie direkt in Ihr Projekt einfügen können.

Verschachtelte Objekte automatisch in eigene Interfaces aufteilen

Wenn Ihr JSON ein weiteres Objekt enthält, erhält dieses ein eigenes benanntes Interface basierend auf dem Feldnamen, was alles übersichtlich hält.

Felder als optional markieren, wenn sich Array-Elemente unterscheiden

Wenn Objekte in einem Array nicht alle dieselben Felder teilen, werden sie zu einem einzigen Interface zusammengeführt, bei dem '?' Felder markiert, die nicht überall vorhanden sind.

Typen für eine GraphQL- oder Webhook-Nutzlast prototypen

Fügen Sie eine Beispiel-Nutzlast wie '{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' ein, um schnell typisierte Interfaces für einen Webhook-Handler zu erhalten, ohne sie von Hand zu schreiben.

Prüfen, wie null-Werte typisiert werden

Nehmen Sie ein Feld wie '{"middleName": null}' in Ihr Beispiel auf, um zu sehen, wie das Tool nullable Felder im erzeugten Interface darstellt.

Kurzübersicht

JSON values → TypeScript types

JSONTypeScript
"hello"type Root = string;
42type Root = number;
3.14type Root = number;
truetype Root = boolean;
nulltype Root = null;
[]type Root = unknown[];
[1, 2, 3]type Root = number[];
["a", "b"]type Root = string[];
[1, "a", true]type Root = (number | string | boolean)[];
[1, null]type Root = (number | null)[];
[[1, 2], [3]]type Root = number[][];
{}interface Root { }

JSON objects → TypeScript interfaces

JSONTypeScript
{"id": 1, "name": "Ada"}interface Root { id: number; name: string; }
{"deletedAt": null}interface Root { deletedAt: null; }
{"tags": ["a", "b"]}interface Root { tags: string[]; }
{"user": {"id": 1}}interface User { id: number; } interface Root { user: User; }
{"items": [{"id": 1}, {"id": 2, "note": "x"}]}interface Item { id: number; note?: string; } interface Root { items: Item[]; }
{"categories": [{"name": "x"}]}interface Category { name: string; } interface Root { categories: Category[]; }
{"first-name": "Ada"}interface Root { "first-name": string; }
{"a": {"x": 1}, "b": {"x": 2}}interface A { x: number; } interface Root { a: A; b: A; }

Häufig gestellte Fragen

Wird mein JSON an einen Server gesendet?

Nein. Die gesamte Umwandlung erfolgt vollständig in Ihrem Browser, und Ihre Eingabe wird niemals an einen Server gesendet.

Kann ich den generierten Code unverändert verwenden?

Er wird aus einem einzigen JSON-Beispiel abgeleitet und erfasst daher möglicherweise nicht jede Variation, die Ihre echten Daten annehmen können. Betrachten Sie das generierte Interface als Ausgangspunkt und passen Sie es bei Bedarf an.

Werden Datumsstrings als Date-Typ erkannt?

Nein. JSON hat keinen eigenen Datumstyp, daher wird jeder String als string behandelt. Wenn Sie ihn als Datum behandeln möchten, passen Sie den generierten Code manuell an.

Was passiert, wenn dieselbe Objektform mehrfach vorkommt?

Objekte mit identischer Struktur verwenden ein einziges Interface erneut, anstatt Duplikate zu erzeugen.

Wie werden leere Arrays typisiert?

Da ein leeres Array keinen Hinweis auf seinen Elementtyp gibt, wird es als 'unknown[]' typisiert. Fügen Sie dem Array mindestens ein Beispielelement hinzu, wenn Sie einen spezifischeren Elementtyp möchten.

Welchen TypeScript-Typ erhält ein null-Wert?

Ein Feld, dessen Beispielwert null ist, wird als 'null' typisiert. Wenn Sie wissen, dass das Feld auch andere Typen enthalten kann, etwa einen String oder gar nicht vorhanden sein kann, müssen Sie den erzeugten Typ von Hand erweitern, zum Beispiel zu 'string | null'.

Beeinflusst die Reihenfolge der Felder in meinem JSON das erzeugte Interface?

Nein. Die Felder werden im erzeugten Interface in derselben Reihenfolge aufgeführt, in der sie in Ihrer Eingabe stehen, doch das Umordnen im Quell-JSON hat auf die erzeugten Typen selbst keine Auswirkung.