Härled ett TypeScript-gränssnitt från JSON

API- och applikationsteam härleder TypeScript-gränssnitt från JSON-exempel när de förbereder datatyper för en applikation.

Härled ett TypeScript-gränssnitt från JSON och anpassa den skapade strukturen till ditt projekt. Använd det gratis direkt i webbläsaren, utan konto.

Så använder du

  1. Klistra in ett JSON-exempel i inmatningsområdet eller importera en kompatibel fil.
  2. Klicka på Generera för att skapa ett TypeScript-gränssnitt.
  3. Resultatet visar typer som härletts från egenskaperna i ditt exempel.
  4. Granska fälten, typerna och möjliga alternativ och kopiera sedan koden.
  5. Använd Radera för att rensa fälten och testa ett annat exempel.

Exempel

Du tar emot ett API-svar och vill snabbt ange typer för innehållet. Klistra in ett JSON-exempel, generera TypeScript-gränssnittet och integrera det sedan i ditt projekt. Du sparar tid på grundläggande typdeklarationer.

Gränser och format

Var bearbetningen sker

Allt sker i din webbläsare: analys och generering är lokala, utan att några data skickas ut. Du kan därför arbeta med utdrag av riktiga svar samtidigt som du behåller konfidentialiteten.

Vanliga frågor

Markeras valfria fält i det genererade gränssnittet?

Verktyget bygger på ett enda exempel. Om ett fält finns med anses det obligatoriskt. Fält som saknas i ditt exempel kan inte gissas vara valfria. Du måste justera dem manuellt.

Kan jag generera gränssnitt för arrayer av objekt?

Ja, om ditt exempel innehåller en array av objekt härleder verktyget elementtypen och återspeglar den i gränssnittet. Kontrollera att den genererade typen matchar strukturen för varje element.

Är den producerade koden direkt kompilerbar?

Det genererade TypeScript-gränssnittet är syntaktiskt korrekt i de flesta fall, men det kan innehålla alltför breda typer eller namn som behöver anpassas. Granska och åtgärda det innan du integrerar det i ditt projekt.

Skickas JSON-exemplet någonstans när typen genereras?

Nej, allt sker i din webbläsare. Analysen och genereringen är lokal, och inga data skickas ut. Du kan därför arbeta med utdrag från verkliga svar och behålla dem konfidentiella. Klistra in ett JSON-exempel eller importera en kompatibel fil, klicka på Generate och granska det föreslagna TypeScript-gränssnittet innan du kopierar koden.

Kan verktyget upptäcka fält som saknas i mitt JSON-exempel?

Nej, gränssnittet bygger på ett enda exempel. Om ett fält finns i exemplet betraktas det som obligatoriskt, medan fält som saknas inte kan gissas som valfria. Komplexa typer som unioner eller literaler identifieras inte. Typnamn kan vara generiska och behöva bytas ut. Granska och justera den genererade koden manuellt innan du använder den i projektet.

Verktyg i samma kategori