JSON zu TypeScript

Beispiel

Eingabe:

{ "id": 1, "name": "Alice", "age": null, "tags": ["admin", "user"], "address": { "city": "Madrid" } }

Ausgabe:

interface User {
  id: number;
  name: string;
  age: number | null;
  tags: string[];
  address: Address;
}

interface Address {
  city: string;
}

Typzuordnung

Optional vs nullable

• foo?: string, das Feld könnte fehlen im Objekt. undefined-Überprüfung gilt.
• foo: string | null, das Feld ist immer vorhanden, könnte aber explizit null sein.
• foo?: string | null, könnte fehlen ODER null sein.

JSON selbst hat kein undefined, aber APIs variieren, wie sie Abwesenheit signalisieren. Passen Sie Ihre API Semantik an:

• REST-APIs lassen typischerweise fehlende Felder weg -> ?:.
• GraphQL gibt immer jedes angeforderte Feld zurück -> | null.
• Einige SDKs verwenden beides in unterschiedlichen Kontexten.

Union vs Literaltypen

Wenn das Tool dasselbe Stringfeld mit einer kleinen Menge von Werten über Beispiele hinweg sieht ("status": "pending", "active", "archived"), kann es eine String-Literal-Union ausgeben:

status: "pending" | "active" | "archived";

Aktivieren Sie “String-Literal-Unionen ableiten”, wenn Sie dies möchten.

Häufige Fehler

• Ableitung aus einem Beispiel. Jedes Feld wird erforderlich; Nullbarkeit kann nicht beobachtet werden. Übergeben Sie 5-10 unterschiedliche Beispiele für bessere Typen.
• Leere Arrays. "tags": [] gibt keine Typinformationen, der Generator gibt unknown[] aus. Stellen Sie ein Beispiel mit mindestens einem Element bereit.
• Gemischte Typ-Arrays. [1, "two", true] produziert (number | string | boolean)[]. In der Regel bedeutet dies, dass das JSON neu gestaltet werden sollte, anstatt typisiert zu werden.
• Numerische String-Schlüssel. JSON {"1": "a", "2": "b"} ist immer noch ein Objekt in TypeScript (Record<string, string>), kein Array. Der Generator behandelt dies korrekt.