Input JSON

Output TypeScript

Cos'è JSON do TypeScript?

TypeScript aggiunge tipi statici a JavaScript. Quando si lavora con JSON da un'API o plik di configurazione, spesso si vuole un'interfaccia o tipo che descriva la struttura. Scriverla a mano è tedioso. Questo narzedzie 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 narzedzie funziona nel browser. Niente viene inviato a un server. L'output segue la sintassi standard di TypeScript.

Jak uzywac tego narzedzia

1

Incolla JSON

Incolla il tuo JSON nell'editor sinistro o carica un plik. Usa Przyklad per dane di esempio. Il generatore deduce i tipi dalla struttura. Usa dane 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

Kopiuj o Pobierz

Usa <strong>Kopiuj</strong> o <strong>Pobierz</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 Walidator JSON.

Dove JSON do 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 plik 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 narzedzie deduce la struttura dal tuo esempio. Per la generazione basata su schema, usa il Generator schematu JSON e narzedzia come quicktype.

Esempi JSON do TypeScript

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

Przyklad: 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 Generator schematu JSON e uno narzedzie come quicktype.

Czesto zadawane pytania

Czy pola opcjonalne są oznaczone?

To zależy od implementacji. Niektóre generatory oznaczają wszystkie pola jako wymagane; inne wnioskują z próbki. Sprawdź dane wyjściowe i dodaj ? tam, gdzie jest to potrzebne.

A co z typami union?

Jeśli ten sam klucz ma różne typy w różnych obiektach, generator może użyć string | number lub podobnego union. Albo może wybrać jeden typ. Sprawdź dane wyjściowe.

Czy moje dane są gdzieś wysyłane?

Nie. Generowanie odbywa się w przeglądarce.

Czy mogę generować typy dla innych języków?

To narzędzie generuje tylko TypeScript. Strona ma konwertery dla C#, Java, Python i innych.

A co z wyliczeniami?

Jeśli pole ma stały zestaw wartości ciągów, generator może wygenerować typ union jak "a" | "b" | "c". Dla jawnych wyliczeń edytuj dane wyjściowe.

Powiazane narzedzia

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).