Generatore di Schema JSON

Il Generatore di Schema JSON trasforma un JSON di esempio in uno schema pronto per il validatore, ideale per API, webhook, file di configurazione, pipeline di dati e documentazione. Incolla un oggetto JSON, un array o un feed NDJSON rappresentativo, scegli lo stile di inferenza e lo strumento creerà uno schema completo di proprietà nidificate, regole per gli elementi dell'array, valori annullabili, esempi e note leggibili percorso per percorso.

Perché usare un Generatore di Schema JSON basato su esempi?

Scrivere un JSON Schema a mano è un processo preciso ma lento, specialmente quando i dati contengono oggetti nidificati, array di record, campi opzionali e valori annullabili. Questo generatore fornisce una prima bozza strutturata che cattura la forma osservata dei dati JSON, evidenziando poi dove è ancora necessario un controllo umano. È utile per la validazione delle richieste API, i contratti di risposta, lo sviluppo con OpenAPI, i payload dei webhook, i flussi di eventi e gli schemi di configurazione.

Istruzioni per l'uso

1. Incolla un oggetto JSON rappresentativo, un array JSON o record JSON delimitati da nuove righe nell'editor di esempio.
2. Seleziona il draft di JSON Schema e decidi se inferire campi obbligatori, esempi, suggerimenti enum, formati di stringa e oggetti chiusi. Per impostazione predefinita, il draft è Draft 2020-12, i campi obbligatori sono impostati su Osservati in ogni oggetto, sono attivi Rileva formati, Includi esempi e Inferisci suggerimenti enum, mentre Oggetti chiusi è disattivato. Il titolo dello schema inizia come GeneratedSchema.
3. Fai clic su Genera JSON Schema per inferire tipi, proprietà nidificate, elementi di array, campi annullabili e suggerimenti di validazione.
4. Controlla la mappa generata per vedere ogni percorso, tipo inferito, stato obbligatorio, formato e regola prima di utilizzare lo schema.
5. Copia lo schema generato e perfeziona le regole di validazione specifiche del dominio, come intervalli esatti, pattern di ID ed enum specifici per il business.

Cosa viene inferito dal generatore

• Tipi JSON fondamentali: object, array, string, number, integer, boolean e null.
• Proprietà degli oggetti nidificati e campi obbligatori in base a ciò che appare in ogni oggetto osservato.
• Schemi degli elementi dell'array unendo gli elementi osservati nel campione.
• Formati di stringa comuni tra cui email, URL, data, data-ora, UUID, IPv4 e IPv6.
• Esempi opzionali, suggerimenti enum, intervalli numerici osservati e lunghezze di stringa osservate.

Domande frequenti (FAQ)

Cosa fa questo Generatore di Schema JSON?

Legge un JSON di esempio e crea un JSON Schema che descrive la forma dei dati osservati. Il generatore inferisce proprietà degli oggetti, array, tipi primitivi, valori annullabili, esempi, suggerimenti enum, campi obbligatori e formati di stringa comuni.

Lo schema generato può essere utilizzato immediatamente in produzione?

Utilizzalo come un valido punto di partenza, quindi esaminalo. I dati di esempio non possono conoscere ogni regola aziendale, pertanto potrebbe essere ancora necessario aggiungere pattern, intervalli esatti, valori enum consentiti, regole di versione e impostazioni additionalProperties più restrittive.

Quali draft di JSON Schema sono supportati?

Lo strumento può generare schemi per Draft 2020-12, Draft 2019-09 e Draft-07 impostando l'URI $schema. La struttura inferita è intenzionalmente compatibile con i validatori comuni.

Come vengono inferiti i campi obbligatori?

Quando l'inferenza dei campi obbligatori è abilitata, una proprietà viene contrassegnata come obbligatoria solo quando appare in ogni oggetto osservato a quel livello. Per un array di oggetti, ciò significa che il campo deve apparire in ogni elemento campionato.

Lo strumento supporta array di oggetti e NDJSON?

Sì. Un array JSON di livello superiore viene trattato come uno schema array, e i record JSON delimitati da nuove righe vengono trattati come un array di record. Le proprietà degli elementi vengono unite a partire dai campioni osservati.