Générateur de schéma JSON

Le Générateur de Schéma JSON transforme un échantillon JSON en un schéma prêt pour la validation pour les API, les webhooks, les fichiers de configuration, les pipelines de données et la documentation. Collez un objet JSON représentatif, un tableau ou un flux NDJSON, choisissez le style d'inférence, et l'outil construit un schéma avec des propriétés imbriquées, des règles d'éléments de tableau, des valeurs nullables, des exemples et des notes lisibles étape par étape.

Pourquoi utiliser un Générateur de Schéma JSON basé sur des échantillons ?

Écrire un JSON Schema à la main est précis mais lent, en particulier lorsque les données contiennent des objets imbriqués, des tableaux d'enregistrements, des champs facultatifs et des valeurs nullables. Ce générateur vous donne un premier projet structuré qui capture la forme observée de vos données JSON, puis met en évidence les points où une révision humaine est encore nécessaire. Il est utile pour la validation des requêtes API, les contrats de réponse, le travail OpenAPI, les charges utiles de webhook, les flux d'événements et les schémas de configuration.

Comment l'utiliser

1. Collez un objet JSON représentatif, un tableau JSON ou des enregistrements JSON délimités par des sauts de ligne dans l'éditeur d'échantillon.
2. Sélectionnez la version de JSON Schema et décidez s'il faut déduire les champs requis, les exemples, les indices d'énumération, les formats de chaînes et les objets fermés. Par défaut, la version est Draft 2020-12, les champs requis sont définis sur Observés dans chaque objet, Détecter les formats, Inclure des exemples et Déduire les indices d'énumération sont activés, et Objets fermés est désactivé. Le titre du schéma commence par GénérateurDeSchémaJSON.
3. Cliquez sur Générer le schéma JSON pour déduire les types, les propriétés imbriquées, les éléments de tableau, les champs nullables et les indices de validation.
4. Vérifiez la carte générée pour voir chaque chemin, le type déduit, le statut requis, le format et la règle avant d'utiliser le schéma.
5. Copiez le schéma généré et affinez les règles de validation spécifiques au domaine telles que les plages exactes, les modèles d'ID et les énumérations propres à l'entreprise.

Ce que le générateur déduit

• Types JSON de base : object, array, string, number, integer, boolean et null.
• Propriétés d'objets imbriqués et champs requis en fonction de ce qui apparaît dans chaque objet observé.
• Schémas d'éléments de tableau en fusionnant les éléments observés dans l'échantillon.
• Formats de chaînes courants, y compris les e-mails, les URL, les dates, les dates-heures, les UUID, les IPv4 et les IPv6.
• Exemples facultatifs, indices d'énumération, plages numériques observées et longueurs de chaînes observées.

FAQ

Que fait ce Générateur de Schéma JSON ?

Il lit un échantillon JSON et crée un schéma JSON qui décrit la forme des données observées. Le générateur déduit les propriétés des objets, les tableaux, les types primitifs, les valeurs nullables, les exemples, les indices d'énumération, les champs requis et les formats de chaînes courants.

Un schéma généré peut-il être utilisé immédiatement en production ?

Utilisez-le comme un excellent point de départ, puis examinez-le. Les données d'échantillon ne peuvent pas connaître toutes les règles métier, vous devrez donc peut-être encore ajouter des modèles, des plages exactes, des valeurs d'énumération autorisées, des règles de version et des paramètres additionalProperties plus stricts.

Quelles versions de JSON Schema sont prises en charge ?

L'outil peut générer des schémas pour les versions Draft 2020-12, Draft 2019-09 et Draft-07 en définissant l'URI $schema. La structure déduite est intentionnellement compatible avec les validateurs courants.

Comment les champs requis sont-ils déduits ?

Lorsque l'inférence des champs requis est activée, une propriété est marquée comme requise uniquement lorsqu'elle apparaît dans chaque objet observé à ce niveau. Pour un tableau d'objets, cela signifie que le champ doit apparaître dans chaque élément échantillonné.

L'outil prend-il en charge les tableaux d'objets et le NDJSON ?

Oui. Un tableau JSON de premier niveau est traité comme un schéma de tableau, et les enregistrements JSON délimités par des sauts de ligne sont traités comme un tableau d'enregistrements. Les propriétés des éléments sont fusionnées à partir des échantillons observés.