JSON in TypeScript-Typen umwandeln!

Gib JSON ein, um es in TypeScript-Interfaces umzuwandeln! Unterstützt TypeScript interface. TypeORM · Sequelize · Mongoose: in den Tabs oben.
JSON
Ergebnis
 

JSON in TypeScript-Typen umwandeln!

Dieses Tool liest einen JSON-Wert und schreibt TypeScript-interface-Deklarationen dafür. Die Keys bleiben exakt, wie sie sind; Arrays von Objekten werden zu einem Interface zusammengeführt, Keys, die nur in manchen Elementen vorkommen, bekommen ?, und gemischte Werte werden zu Union-Typen.

Verwende es, um fetch- oder axios-Antworten im Frontend zu typisieren, um Rückgabetypen für Next.js-API-Routen oder Express-Handler zu deklarieren oder immer dann, wenn ein Backend nur Beispielantworten und keine Typdefinitionen dokumentiert.

So funktioniert es

  1. Füge ein Antwort-JSON ein, zum Beispiel aus dem Network-Tab der DevTools kopiert.
  2. Gib den Namen des Wurzel-Interfaces in Typname ein (z. B. ChannelHistory); er bleibt als ?name= in der URL.
  3. Speichere die Ausgabe in einer Datei wie types.ts und verwende sie über import type { ChannelHistory } from "./types".

Beispiel

Eingabe (JSON)
{
  "channel": "general",
  "messages": [
    { "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
    { "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
  ],
  "cursor": 42
}
Ausgabe (TypeScript)
export interface ChannelHistory {
  channel: string;
  messages: Message[];
  cursor: number;
}

export interface Message {
  id: string;
  user: string;
  text: string | null;
  reactions?: string[];
  edited?: boolean;
  attachment?: Attachment;
}

export interface Attachment {
  type: string;
  url: string;
}

Beide Nachrichten werden zu einem einzigen Interface Message zusammengeführt; reactions, edited und attachment kommen nur in einer davon vor und bekommen daher ?. text mischt einen String und null, was string | null ergibt. Element-Interfaces bekommen die Singularform des Keys (messages → Message).

Unterstützte Funktionen

  • Jede Deklaration ist ein export interface, bereit zum Importieren an anderer Stelle.
  • JSON-Keys werden nicht umbenannt, die Typen entsprechen dem Antwortobjekt also eins zu eins; Keys, die keine gültigen Bezeichner sind ("a-b", "2fa"), werden in Anführungszeichen gesetzt.
  • Arrays von Objekten führen die Keys aller Elemente zusammen; Keys, die in manchen Elementen fehlen, werden optional (?:).
  • Gemischte Typen ergeben Unions (string | number); null wird zuletzt als | null angehängt. Gemischte Arrays werden zu (string | number)[].
  • Leere Arrays haben keinen ableitbaren Elementtyp und werden zu unknown[].
  • Ein Array auf oberster Ebene erzeugt zusätzlich einen Alias wie export type Root = RootItem[];.

Anwendungsfälle

fetch- und axios-Antworten typisieren

Übergib den Typ als Generic, z. B. const res = await axios.get<ChannelHistory>(url), und der Editor warnt dich, dass res.data.messages[0].text null sein kann.

Drittanbieter-APIs ohne Typings

Für interne oder externe APIs ohne SDK oder @types-Paket genügt eine einzige Beispielantwort, um eine Typdefinitionsdatei zu erzeugen, die du mit dem Team teilst.

Mock-Daten und Komponenten-Props

Erzeuge Interfaces aus dem Mock-JSON von Storybook oder Tests und verwende sie als Props-Typen von Komponenten; laufen Mocks und Komponenten auseinander, meldet es der Compiler.

Hinweise und Einschränkungen

  • Interfaces verschwinden beim Kompilieren und prüfen zur Laufzeit nicht, ob eine Antwort wirklich diese Form hat. Kombiniere sie mit einer Schema-Bibliothek wie zod, wenn du Laufzeitvalidierung brauchst.
  • Alle Zahlen sind number (keine Trennung in Ganz- und Gleitkommazahlen), und Datums-Strings sind string.
  • Felder mit einer festen Wertemenge wie "status": "active" kommen als string heraus; schränke sie selbst auf Literal-Unions ("active" | "banned") ein.
  • Identische Formen unter verschiedenen Keys bekommen jeweils ein eigenes Interface, und kollidierende Namen erhalten ein numerisches Suffix wie Profile2.

Häufige Fragen

Kann ich type-Aliase statt Interfaces bekommen?

Ein type-Alias wird nur für ein Array oder einen primitiven Wert auf oberster Ebene verwendet; Objekte sind immer interfaces. export interface X { ... } als export type X = { ... }; umzuschreiben verhält sich für diesen Zweck gleich.

Warum werden optional (?) und | null getrennt gehalten?

Sie bedeuten Verschiedenes: ? sagt, dass der Key fehlen darf (undefined), während | null sagt, dass der Key mit dem Wert null vorhanden ist. Mit aktiviertem strictNullChecks behandelst du die beiden Fälle unterschiedlich.

Warum werden Keys nicht in camelCase umgewandelt?

Ein TypeScript-Typ beschreibt das tatsächliche Objekt, umbenannte Keys würden also nicht mehr zur Antwort passen. Willst du in deinem Code camelCase, definiere einen eigenen Typ für das Ergebnis deiner Mapping-Funktion.

Ich brauche ORM-Entities (TypeORM, Sequelize, Mongoose).

Diese Seite gibt nur reine Typdeklarationen aus. Die Tabs TypeORM, Sequelize und Mongoose oben erzeugen Entity- und Modellcode aus demselben JSON.