Input JSON

Output TypeScript

Cos'è JSON a TypeScript?

TypeScript aggiunge tipi statici a JavaScript. Quando si lavora con JSON da un'API o file di configurazione, spesso si vuole un'interfaccia o tipo che descriva la struttura. Scriverla a mano è tedioso. Questo strumento deduce le interfacce TypeScript dal tuo JSON: esamina le chiavi e i valori e genera le corrispondenti definizioni di tipo.

Incolla JSON, ottieni TypeScript. Lo strumento funziona nel browser. Niente viene inviato a un server. L'output segue la sintassi standard di TypeScript.

Come Usare Questo Strumento

1

Incolla JSON

Incolla il tuo JSON nell'editor sinistro o carica un file. Usa Esempio per dati di esempio. Il generatore deduce i tipi dalla struttura. Usa dati rappresentativi che mostrano tutti i campi che ti interessano.

2

Rivedi le Interfacce

Il pannello destro mostra le interfacce generate. Gli oggetti annidati ottengono le proprie interfacce. Gli array sono tipizzati come Type[]. I campi opzionali possono usare ? a seconda dell'implementazione.

3

Copia o Scarica

Usa <strong>Copia</strong> o <strong>Scarica</strong> per ottenere il TypeScript. Incollalo nel tuo progetto. Potresti dover aggiustare i nomi, aggiungere generici o correggere i campi opzionali. Per validare prima il JSON, usa il Validatore JSON.

Dove JSON a TypeScript è Utile

Quando si integrano API, spesso si hanno bisogno di tipi per il payload della risposta. Incollare qui una risposta di esempio fornisce interfacce che puoi inserire nel tuo progetto Angular, React o Node. I file di configurazione, i payload webhook e i documenti di database traggono vantaggio dallo stesso trattamento. Scrivere manualmente le interfacce per strutture annidate complesse è soggetto a errori; questo strumento deduce la struttura dal tuo esempio. Per la generazione basata su schema, usa il Generatore Schema JSON e strumenti come quicktype.

Esempi JSON a TypeScript

Ecco un esempio di generazione di interfacce TypeScript da un oggetto JSON.

Esempio: Record abbonato

Input JSON:

Input JSON

Output TypeScript generato:

Output TypeScript

Limitazioni

Il generatore deduce dal campione. Se un campo può essere <code>string | number</code> ma il tuo campione ha solo stringhe, il tipo sarà <code>string</code>. Se gli array possono essere vuoti, il tipo dell'elemento potrebbe essere <code>unknown</code>. Rivedi e modifica l'output. Per la generazione basata su schema, usa il Generatore Schema JSON e uno strumento come quicktype.

Domande Frequenti

I campi opzionali sono contrassegnati?

Dipende dall'implementazione. Alcuni generatori contrassegnano tutti i campi come richiesti; altri deducono dal campione. Controlla l'output e aggiungi ? dove necessario.

E i tipi union?

Se la stessa chiave ha tipi diversi in oggetti diversi, il generatore potrebbe usare string | number o un union simile. O potrebbe scegliere un tipo. Rivedi l'output.

I miei dati vengono inviati da qualche parte?

No. La generazione avviene nel browser.

Posso generare tipi per altri linguaggi?

Questo strumento produce solo TypeScript. Il sito ha convertitori per C#, Java, Python, e altri.

E le enumerazioni?

Se un campo ha un insieme fisso di valori stringa, il generatore potrebbe produrre un tipo union come "a" | "b" | "c". Per le enumerazioni esplicite, modifica l'output.

Strumenti Correlati

Per TypeScript, vedi typescriptlang.org e oggetti TypeScript. Per JSON, vedi json.org e MDN JSON. Per la generazione da schema a codice, vedi quicktype. Per RFC 8259 (specifica JSON).