Cosa fa il Generatore di JSON Schema?

Crea un JSON Schema a partire da un esempio dei tuoi dati. Incolla un campione, ad esempio una risposta API, un file di configurazione o un record esportato da un database, e otterrai uno schema che ne descrive la struttura: il tipo di ogni valore, le proprietà di ogni oggetto, l’aspetto degli elementi di ogni array e quali proprietà sono obbligatorie. È un punto di partenza rapido per la documentazione API, le specifiche OpenAPI, la convalida dei moduli o i contratti dei dati, che potrai poi perfezionare manualmente.

Come si usa

  1. Incolla o digita un campione JSON nel campo di input.
  2. Scegli la bozza di JSON Schema da usare nella riga $schema: Draft 2020-12 o Draft 7.
  3. Scegli se contrassegnare le proprietà come obbligatorie.
  4. Copia lo schema o scaricalo come schema.json.

Se il campione non è JSON valido, lo strumento indica la riga e la colonna dell’errore e lo evidenzia.

Come viene elaborato lo schema

  • A ogni valore viene assegnato il relativo tipo JSON: string, boolean, null, object, array e integer per i numeri interi oppure number per i numeri decimali. Un array di numeri interi e decimali viene indicato come number, che comprende entrambi.
  • Per ogni chiave, agli oggetti viene aggiunta una voce properties, descritta allo stesso modo e in profondità quanto consente il campione.
  • Agli array viene assegnato un unico schema items, adatto a tutti gli elementi. Se gli elementi sono oggetti, le relative proprietà vengono unite, così una lista di record produce un unico schema per un record.
  • Ai valori con tipi diversi vengono assegnati tutti i tipi in un elenco, come ["string", "null"], oppure un anyOf quando sono presenti oggetti e altri valori.
  • A un array vuoto viene assegnato "type": "array" senza items, perché non c’è nulla da descrivere.

Proprietà obbligatorie

Quando l’opzione «Contrassegna le proprietà come obbligatorie» è attiva, ogni oggetto elenca le proprie chiavi sotto required. In un array di oggetti, una proprietà è obbligatoria solo se è presente in ogni elemento: in una lista di membri in cui solo alcuni hanno una proprietà favorite, quest’ultima è facoltativa. Disattiva l’opzione per ottenere uno schema senza elenchi required.

Cosa non si può dedurre da un campione

Uno schema generato da un singolo esempio conosce solo ciò che è mostrato nell’esempio. Non può sapere quali valori stringa siano indirizzi email o date, quali intervalli possano assumere i numeri o se una proprietà presente una sola volta possa anche mancare. Aggiungi manualmente format, minimum, maxLength, enum o pattern dove necessario e verifica i dati con il JSON Schema Validator.

Come funziona

Lo strumento usa genson-js, un porting in JavaScript del generatore di schemi GenSON. Le parole chiave che genera hanno lo stesso significato in Draft 7 e Draft 2020-12, quindi la bozza modifica solo la riga $schema. Tutto viene eseguito nel browser: il campione non viene mai caricato.

Funzionalità

  • Generazione di JSON Schema a partire da qualsiasi campione JSON
  • Tipi, oggetti annidati e array elaborati automaticamente
  • Elementi degli array uniti in un unico schema, con individuazione delle proprietà facoltative
  • Draft 2020-12 o Draft 7
  • Proprietà obbligatorie attivabili o disattivabili
  • Copia o download come schema.json
  • Esecuzione nel browser