Entrée JSON

Schéma généré

Qu'est-ce qu'un générateur de schéma JSON ?

Avez-vous déjà dû écrire un JSON Schema à la main depuis zéro ? C'est fastidieux. Cet outil le fait pour vous — collez un objet JSON de référence et il génère instantanément un schéma décrivant cette structure : types, propriétés, champs obligatoires et objets imbriqués. Le schéma généré suit les conventions JSON de RFC 8259 et est compatible avec des outils comme Ajv. Utilisez-le pour démarrer votre documentation d'API, valider des pipelines de données ou créer des schémas pour vos spécifications OpenAPI.

Cet outil s'exécute dans votre navigateur. Collez votre JSON et il génère un brouillon de schéma JSON. Rien n'est envoyé à un serveur.

Comment utiliser cet outil

1

Coller un exemple JSON

Collez du JSON qui représente la structure que vous souhaitez décrire. Utilisez Exemple ou Importer si nécessaire. Le générateur déduit les types à partir des valeurs (string, number, boolean, array, object).

2

Examiner le schéma

Le panneau droit affiche le schéma généré. Il peut inclure type, properties, required et des schémas imbriqués pour les objets. Vous pouvez le modifier manuellement si nécessaire.

3

Copier ou télécharger

Utilisez Copier ou Télécharger pour obtenir le schéma. Pour valider du JSON contre un schéma, utilisez le Validateur JSON ou une bibliothèque comme Ajv.

Exemples de schéma JSON

Générer un schéma à partir d'un exemple JSON. Exemple à thème télécom :

Entrée JSON

Entrée

Schéma généré

Sortie

Quand utiliser un schéma généré

Les schémas générés sont un point de départ. Ils capturent la structure de vos données d'exemple mais peuvent être trop stricts ou trop souples. Vous pourriez avoir besoin d'ajouter des tableaux required, d'ajuster les types ou d'ajouter enum pour les valeurs autorisées. La documentation JSON Schema explique le vocabulaire complet. Pour la documentation d'API, des outils comme OpenAPI peuvent référencer JSON Schema.

Exemple : Générer un schéma à partir d'un objet utilisateur

Entrée JSON :

{
  "id": 1,
  "name": "Alice",
  "email": "[email protected]",
  "age": 30,
  "active": true
}

JSON Schema généré :

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": { "type": "integer" },
    "name": { "type": "string" },
    "email": { "type": "string" },
    "age": { "type": "integer" },
    "active": { "type": "boolean" }
  }
}

Questions fréquentes

Puis-je valider du JSON avec ce schéma ?

Cet outil ne fait que générer des schémas. Pour valider, utilisez le Validateur JSON ou une bibliothèque comme Ajv dans votre code.

Et si mon JSON a des formes différentes ?

Le générateur déduit à partir de l'exemple que vous fournissez. Si votre JSON peut avoir plusieurs formes (ex. champs optionnels), le schéma pourrait nécessiter des modifications manuelles. Utilisez oneOf ou anyOf pour les variantes.

Mes données sont-elles envoyées quelque part ?

Non. La génération s'exécute dans votre navigateur.

Quel brouillon JSON Schema est utilisé ?

L'outil peut utiliser draft-07 ou draft-2020-12. Vérifiez le schéma généré pour $schema pour voir la version. La spécification JSON Schema contient les détails.

Puis-je utiliser cela pour les réponses API ?

Oui. Collez une réponse API typique. Le schéma généré décrit cette structure. Vous pouvez ensuite l'utiliser dans OpenAPI/Swagger ou pour la documentation.

Outils connexes

En savoir plus sur json-schema.org et JSON Schema learn. Pour la validation dans le code, voir Ajv. Pour le JSON, voir json.org, MDN et RFC 8259. Pour la documentation d'API, voir OpenAPI.