Que fait le générateur de schémas JSON ?

Il crée un schéma JSON à partir d’un exemple de vos données. Collez un exemple, comme une réponse d’API, un fichier de configuration ou un enregistrement issu d’un export de base de données, et vous obtenez un schéma qui en décrit la structure : le type de chaque valeur, les propriétés de chaque objet, la forme des éléments de chaque tableau et les propriétés obligatoires. C’est un moyen rapide de commencer à créer une documentation d’API, des spécifications OpenAPI, des règles de validation de formulaires ou des contrats de données, que vous pourrez ensuite affiner manuellement.

Comment l’utiliser

  1. Collez ou saisissez un exemple JSON dans la zone de saisie.
  2. Choisissez la version de JSON Schema à utiliser pour la ligne $schema : Draft 2020-12 ou Draft 7.
  3. Choisissez si les propriétés doivent être marquées comme obligatoires.
  4. Copiez le schéma ou téléchargez-le sous le nom schema.json.

Si l’exemple n’est pas un JSON valide, l’outil indique la ligne et la colonne de l’erreur, et la signale.

Comment le schéma est généré

  • Chaque valeur reçoit son type JSON : string, boolean, null, object, array et integer pour les nombres entiers, ou number pour les nombres décimaux. Un tableau contenant des nombres entiers et décimaux reçoit le type number, qui couvre les deux cas.
  • Chaque objet reçoit une entrée properties pour chaque clé, décrite de la même manière, jusqu’au niveau de profondeur de l’exemple.
  • Chaque tableau reçoit un schéma items qui convient à tous ses éléments. Lorsque les éléments sont des objets, leurs propriétés sont fusionnées : une liste d’enregistrements donne ainsi un seul schéma pour un enregistrement.
  • Les valeurs de types différents sont associées à tous les types concernés dans une liste, comme ["string", "null"], ou à un anyOf lorsque des objets et d’autres valeurs sont mélangés.
  • Un tableau vide reçoit "type": "array" sans items, car il n’y a rien à décrire.

Propriétés obligatoires

Lorsque l’option « Marquer les propriétés comme obligatoires » est activée, les clés de chaque objet sont répertoriées dans required. Pour un tableau d’objets, une propriété n’est obligatoire que si elle figure dans chaque élément : dans une liste de membres où certains seulement ont une propriété favorite, celle-ci est facultative. Désactivez l’option pour obtenir un schéma sans liste required.

Ce qu’un exemple ne peut pas indiquer

Un schéma créé à partir d’un seul exemple ne connaît que les informations présentes dans celui-ci. Il ne peut pas savoir quelles valeurs de type chaîne sont des adresses e-mail ou des dates, quelles plages de valeurs les nombres peuvent couvrir, ni qu’une propriété observée une seule fois peut aussi être absente. Ajoutez manuellement format, minimum, maxLength, enum ou pattern si nécessaire, puis vérifiez les données à l’aide du validateur JSON Schema.

Fonctionnement

L’outil utilise genson-js, un portage JavaScript du générateur de schémas GenSON. Les mots-clés générés ont la même signification dans Draft 7 et Draft 2020-12 ; seule la ligne $schema change selon la version. Tout s’exécute dans votre navigateur : l’exemple n’est jamais envoyé.

Fonctionnalités

  • Génération d’un schéma JSON à partir de n’importe quel exemple JSON
  • Détermination automatique des types, des objets imbriqués et des tableaux
  • Fusion des éléments d’un tableau dans un seul schéma, avec détection des propriétés facultatives
  • Draft 2020-12 ou Draft 7
  • Activation ou désactivation des propriétés obligatoires
  • Copie ou téléchargement sous le nom schema.json
  • Fonctionnement dans votre navigateur