Verwenden Sie diesen JSON-zu-TypeScript-Generator, um typsichere Schnittstellen und Typen aus JSON-Beispielen für Frontend-Apps und Node.js-Dienste zu erstellen.
Schritt 1 – Fügen Sie ein JSON-Beispiel ein
- Fügen Sie ein repräsentatives JSON-Objekt oder -Array in den linken Editor ein.
- Schließen Sie verschachtelte Objekte, Arrays und Nullable-Felder ein, damit Typen korrekt abgeleitet werden.
- Verwenden Sie
Import, um JSON aus einer Datei, URL oder Beispieldaten zu laden.
Schritt 2 – Wählen Sie die Optionen für die TypeScript-Generierung
- Legen Sie einen
Root Type Name fest, der Ihrem Modell entspricht (zum Beispiel Root). - Wählen Sie eine Null-Handhabungsstrategie (
Optional (?) vs. Union (| null)), die zu Ihrer Codebasis passt. - Entscheiden Sie, ob Sie die Aliase
interfaces oder type für die Ausgabe verwenden möchten.
Schritt 3 – Überprüfen Sie den generierten Code
- Überprüfen Sie Feldnamen, Typen und die Modellierung von Arrays/Objekten.
- Passen Sie Optionen wie
Root Type Name, Nullbehandlung und Frameworks an, falls verfügbar. - Wenn ein Feld falsch abgeleitet wird, optimieren Sie Ihren Beispiel-JSON und generieren Sie ihn neu.
Schritt 4 – Verwenden Sie die generierten Typen
- Fügen Sie die Ausgabe in Ihr Projekt ein und exportieren Sie sie aus Ihrem Typenmodul.
- Verwenden Sie die Typen für API-Antworten, DTOs und Laufzeit-Parsing-Grenzen.
- Führen Sie eine Neugenerierung durch, wenn sich Ihre JSON-Nutzlast ändert, um die Clients synchron zu halten.
Schritt 5 – Kopieren oder Herunterladen
- Kopieren Sie die Ausgabe in Ihr Projekt oder laden Sie sie als Datei herunter.
- Führen Sie Ihren Formatierer/Linter entsprechend Ihrem Codestil aus.
- Fügen Sie JSON-Parsing-/Serialisierungsbibliotheken hinzu, wenn Ihre Sprache dies erfordert.
Beispielausgabe (vereinfacht)
// JSON-Eingabe
{
"id": 123,
"name": "Maeve Winters",
"email": "[email protected]",
"active": true,
"roles": ["admin", "editor"],
"metadata": { "plan": "pro" },
"createdAt": "2024-03-01T10:15:00Z",
"score": 99.5,
"notes": null
}
// Generated TypeScript types (simplified)
export interface Metadata {
plan: string;
}
export interface Root {
id: number;
name: string;
email: string | null;
active: boolean;
roles: string[];
metadata: Metadata;
createdAt: string;
score: number;
notes: null;
}