Validation JSON Schema

Qu’est-ce que la validation JSON Schema ?

La validation JSON Schema consiste à comparer des données JSON à un Schema afin de vérifier si leur structure et leur contenu respectent les règles définies. Il est notamment possible d’imposer la présence d’un champ, son type, la structure des éléments d’un tableau ou des limites sur les nombres et les chaînes.

Quelle est la différence entre JSON et Schema ?

À gauche, saisissez les données JSON à vérifier ; à droite, saisissez le JSON Schema. Le JSON représente les données réelles, tandis que le Schema décrit leur structure et leurs contraintes. Les deux sont fournis séparément et l’outil utilise le Schema pour valider le JSON.

Quelles règles JSON Schema sont courantes ?

Les règles courantes comprennent type pour définir le type de données, required pour les propriétés obligatoires, properties pour décrire les champs d’un objet, items pour les éléments d’un tableau, ainsi que enum, const, minimum, maximum, minLength et maxLength. La portée exacte dépend de l’implémentation du validateur utilisée par la page.

Comment lire le résultat de validation ?

Lorsque la validation réussit, les données JSON respectent le Schema fourni. Lorsqu’elle échoue, la zone de résultats indique les emplacements et les causes des erreurs afin de localiser les propriétés manquantes, les types incorrects ou les valeurs qui ne respectent pas les contraintes. Commencez par vérifier le chemin d’erreur, puis la règle correspondante dans le Schema.

Comment utiliser required dans JSON Schema ?

required sert à définir les propriétés qui doivent exister dans un objet. Par exemple, si le Schema contient required: ["name"], l’objet JSON doit posséder la propriété name. Notez que required vérifie l’existence de la propriété et ne détermine pas à lui seul son type ou si sa valeur peut être vide.

Que sont properties et additionalProperties ?

properties décrit les champs précis d’un objet, par exemple en définissant name comme une chaîne et age comme un nombre. additionalProperties permet ensuite de contrôler si les propriétés qui ne sont pas définies dans le Schema sont autorisées. Pour interdire les champs inconnus, vous pouvez définir explicitement la règle correspondante dans le Schema de l’objet.

Comment valider des fichiers JSON locaux ?

Passez à l’onglet de téléversement de fichiers et sélectionnez un fichier pour les données JSON et un autre pour le Schema. Les fichiers sont lus dans le navigateur et utilisés localement pour la validation, ce qui convient aux fichiers de configuration, données d’API et autres documents JSON locaux. La limite de taille par fichier est indiquée sur la page.

Que faire en cas d’échec de validation ?

Si le résultat indique une erreur de format JSON, vérifiez d’abord que le contenu est un JSON valide. Si le JSON est correctement analysé mais ne respecte pas le Schema, utilisez le chemin de l’erreur pour examiner le champ concerné. Les problèmes courants sont une propriété obligatoire manquante, un type incorrect, une structure de tableau incompatible avec items, une valeur absente de enum ou une valeur numérique ou textuelle hors des contraintes.

Dans quels cas utiliser JSON Schema ?

JSON Schema est couramment utilisé pour valider les données d’API, contrôler les fichiers de configuration, imposer des contraintes entre frontend et backend, traiter des données en lot et effectuer des tests de développement. Définir d’abord la structure des données puis valider les JSON réels permet de détecter les problèmes de structure et de champs avant leur traitement ultérieur.