JSON till TypeScript

Exempel

Indata:

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

Utdata:

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

interface Address {
  city: string;
}

Typmappning

Valfritt fält kontra nullbart fält

• foo?: string, fältet kan saknas i objektet. En undefined-kontroll gäller.
• foo: string | null, fältet är alltid närvarande, men kan uttryckligen vara null.
• foo?: string | null, kan saknas ELLER vara null.

JSON i sig har inte undefined, men olika API:er signalerar frånvaro på olika sätt. Anpassa efter semantiken hos ditt API.

• REST-API:er utelämnar vanligtvis saknade fält -> ?:.
• GraphQL returnerar alltid varje begärt fält -> | null.
• Vissa SDK:er använder båda i olika sammanhang.

Uniontyper kontra literala typer

Om verktyget ser att samma strängfält bara antar en liten uppsättning värden över exemplen ("status": "pending", "active", "archived") kan det generera en union av strängliteraler:

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

Aktivera “härled unioner av strängliteraler” om du vill ha detta.

Vanliga misstag

• Härleda från ett enda exempel. Varje fält blir obligatoriskt; nullbarhet kan inte observeras. Ge 5-10 varierade exempel för bättre typer.
• Tomma arrayer. "tags": [] ger ingen typinformation, generatorn producerar unknown[]. Ange ett exempel med minst ett element.
• Arrayer med blandade typer. [1, "two", true] ger (number | string | boolean)[]. Vanligtvis betyder det att JSON:en bör designas om i stället för att typas som den är.
• Numeriska strängnycklar. JSON {"1": "a", "2": "b"} är fortfarande ett objekt i TypeScript (Record<string, string>), inte en array. Generatorn hanterar detta korrekt.