Vai al contenuto

Schema JSON per TypeScript

Converti uno schema JSON in tipi TypeScript. Gli oggetti diventano interfacce con proprietà obbligatorie e opzionali; $defs e le definizioni diventano esportazioni con nome a cui fa riferimento $ref; enum e const diventano tipi letterali, anyOf e oneOf diventano unioni e allOf un'intersezione. Le descrizioni vengono conservate come commenti di documentazione.

Reimposta

Domande frequenti

Quali bozze di schema JSON sono supportate?

Il convertitore legge le parole chiave condivise da draft-07, 2019-09 e 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf e $ref in $defs o definitions. Le parole chiave di convalida come minLength o pattern non hanno un equivalente in TypeScript e vengono omesse.

Come vengono risolti i riferimenti $ref?

I riferimenti a #, #/$defs/Name e #/definitions/Name diventano il tipo con nome della definizione corrispondente. Qualsiasi altro riferimento, per esempio a un altro file o a un URL, viene tipizzato come unknown e riportato in un commento all'inizio dell'output.

Come viene gestito additionalProperties?

Un oggetto senza proprietà e con uno schema additionalProperties diventa Record<string, T>. Un oggetto con proprietà e uno schema additionalProperties diventa l'interfaccia unita a Record<string, T>. additionalProperties false o una parola chiave assente non aggiungono nulla, perché i tipi di oggetto TypeScript descrivono già le chiavi note.

Che effetto ha nullable?

La parola chiave nullable: true di OpenAPI 3.0 e l'estensione x-nullable di Swagger aggiungono | null al tipo. Nello schema JSON stesso, scrivi type: ["string", "null"], che diventa string | null.

Gli schemi ricorsivi sono supportati?

Sì. Una definizione che fa riferimento a sé stessa o a un'altra definizione tramite $ref diventa un tipo con nome che fa riferimento all'altro nome; TypeScript lo risolve senza problemi.

Verifica che lo schema sia valido?

Legge soltanto lo schema. Le parole chiave sconosciute vengono ignorate e uno schema senza type diventa unknown. Usa il validatore di schemi JSON per verificare i dati rispetto a uno schema.

Informazioni su OneClick Pro

OneClick Pro è una raccolta gratuita di oltre 150 strumenti web per le attività quotidiane: convertire immagini e unità di misura, formattare e convalidare codice, controllare domini e SEO, lavorare con testi, date e numeri. Ogni strumento funziona senza registrazione né abbonamento; i dati inseriti vengono usati solo per calcolare il risultato e non vengono mai salvati. Usatelo come cassetta degli attrezzi per attività occasionali oppure aggiungete ai preferiti gli strumenti che usate ogni giorno.