TypeScript-Typen in JSON umwandeln!

Gib TypeScript-Interfaces ein, um Beispiel-JSON zu erzeugen! Unterstützt TypeScript interface, type. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
TypeScript
Ergebnis
 

TypeScript-Typen in JSON umwandeln!

Füge TypeScript-Deklarationen von interface, type-Alias, enum oder Klassen ein und erhalte ein Beispiel-JSON-Dokument, das sie erfüllt. Literal-Unions, Record, Utility-Typen wie Pick, Omit und Partial sowie mit extends verkettete Interfaces werden alle verfolgt und befüllt.

Verwende es, bevor eine API existiert, um Mock-Daten für MSW oder json-server vorzubereiten, um Props für Storybook zu erzeugen oder um dem Backend-Team genau zu zeigen, welche Form es senden soll.

So funktioniert es

  1. Füge Typdeklarationen aus einer Datei wie types.ts ein. export, import und Funktionsdeklarationen dürfen dazwischen stehen; gelesen werden nur Typdeklarationen.
  2. Nimm referenzierte Typen und enums mit auf, damit sie befüllt werden. Typnamen, die in der Eingabe fehlen, werden zu null.
  3. Optionen gibt es keine. Der erste Objekttyp, auf den keine andere Deklaration verweist, wird zur Wurzel; setze den gewünschten also an den Anfang. Ein Alias, der ein Generic ausfüllt, etwa type UserPage = Page<User>, wird gegenüber der generischen Deklaration selbst bevorzugt.
  4. Kopiere das Ergebnis in HttpResponse.json(...) eines MSW-Handlers, ein Test-Fixture oder die args von Storybook und passe dann die Werte an.

Beispiel

Eingabe (TypeScript)
type Channel = "email" | "sms" | "push";

enum Priority { Low = "low", High = "high" }

interface Notification {
  id: string;
  channel: Channel;
  priority: Priority;
  recipient: { userId: number; locale?: string };
  payload: Record<string, string>;
  readAt: Date | null;
  meta: Pick<Audit, "createdBy">;
}

interface Audit { createdBy: string; createdAt: Date }
Ausgabe (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel ist eine Union aus String-Literalen und nimmt daher ihren ersten Wert "email"; das String-Enum Priority nimmt den Wert seines ersten Members, "low". Record<string, string> wird zu einem Objekt mit einem einzigen "key", Date | null wird zur Nicht-null-Seite als ISO-String aufgelöst, und Pick<Audit, "createdBy"> behält nur den ausgewählten Key. Auch das optionale locale? ist enthalten.

Unterstützte Funktionen

  • Primitive Typen: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (das Format von Date.toJSON()).
  • Literal-Typen verwenden ihren Wert, Unions nehmen das erste Member, das nicht null/undefined ist, und Intersections (A & B) sowie interface ... extends führen Properties zusammen.
  • Ein enum verwendet den Wert seines ersten Members, bei einem numerischen Enum ohne Initialisierer 0.
  • Arrays, Array<T> und Set<T> bekommen ein Beispielelement; Tupel bekommen einen Wert pro Position; Record<K, V>, Map und Index-Signaturen werden zu {"key": V}.
  • Unterstützt die Utility-Typen Partial, Required, Readonly, NonNullable, Pick und Omit.
  • Methoden und Properties mit Funktionstyp gibt es in JSON nicht, sie fallen weg; in Klassen werden static-Felder, get/set-Accessoren und @Exclude()-Felder ausgeschlossen.
  • Selbstreferenzierende Arrays (children: TreeNode[]) werden als leere Arrays abgeschnitten.

Anwendungsfälle

Mock-Antworten für MSW oder json-server

Solange das Backend nicht fertig ist, erzeugst du Mock-Daten aus den Typen der API-Antworten. Die UI lässt sich zuerst bauen, und beim späteren Wechsel zur echten API bleiben die Typen dieselben.

Props für Storybook und Tests

Erstelle aus dem Props-Typ einer Komponente ein Standardobjekt für die args einer Story oder für Render-Daten in React Testing Library. Jede Pflicht-Property ist vorhanden, es gibt also keine Typfehler zu jagen.

Request-Formate mit dem Backend abstimmen

Mach aus einem Request-Typ des Frontends JSON und füge es in ein API-Designdokument oder ein Issue ein, damit Backend-Entwickler ohne TypeScript die Struktur sofort lesen können.

Hinweise und Einschränkungen

  • Optionale Properties (?) sind immer enthalten; lösche Keys selbst, um Antworten zu testen, in denen sie fehlen.
  • Generische Parameter werden dort eingesetzt, wo der Typ verwendet wird: Bei type UserPage = Page<User> wird items: T[] mit User befüllt, und Standardwerte wie <T = string> greifen, wenn kein Argument angegeben ist. Bedingte Typen innerhalb von Generics werden trotzdem nicht ausgewertet.
  • Indexed-Access-Typen wie T["key"], bedingte Typen und Template-Literal-Typen werden nicht ausgewertet.
  • Ein Klassenfeld, das mit einem einzelnen Literal initialisiert ist (name = "kim", retries = 3), verwendet diesen Wert; andere Initialisierer wie new Date() geben nur einen Hinweis auf den Typ.
  • Laufzeit-Schemacode wie Zod oder io-ts wird nicht gelesen; schreibe den von z.infer abgeleiteten Typ als einfaches Interface aus.
  • Map und Set werden als Objekt und Array dargestellt, JSON.stringify macht aber aus beiden {}; verwende in Antworttypen besser Record oder Arrays.

Häufige Fragen

Ist es richtig, dass Date als String herauskommt?

Ja. JSON.stringify ersetzt ein Date durch das Ergebnis von toJSON(), einen ISO-8601-String. Auch die Empfängerseite bekommt einen String, typisiere ihn also entweder als string oder parse ihn.

Welchen Wert bekommt eine Union wie status: "active" | "inactive"?

Das erste Literal in Deklarationsreihenfolge, "active". Ordne die Union um, wenn du lieber einen anderen Wert zeigen willst.

Funktioniert es mit DTO-Klassen aus NestJS?

Klassendeklarationen und Decorators werden geparst, mit Decorators von class-validator annotierte DTOs lassen sich also problemlos umwandeln, und @Exclude()-Felder von class-transformer werden weggelassen.

Wie komme ich von JSON zu TypeScript-Typen?

Für die umgekehrte Richtung nimm die Seite JSON → TypeScript. Eigene Seiten erzeugen außerdem JSON aus TypeORM-, Sequelize- und Mongoose-Modellen.