Qu'est-ce que JSON Schema ?
JSON Schema est un standard pour décrire la structure attendue d'un document JSON. Voyez-le comme un système de types pour vos données : il définit quels champs doivent exister, quel type chaque champ doit avoir, et quels champs sont requis. Quand les données arrivent à votre API, vous les vérifiez contre le schéma — et rejetez tout ce qui ne correspond pas avant que cela n'atteigne votre logique applicative.
{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]}Pourquoi utiliser JSON Schema ?
Sans validation de schéma, un champ requis manquant provoque une erreur au plus profond de votre logique applicative — parfois des heures après l'arrivée des mauvaises données. Avec la validation de schéma, le problème est détecté immédiatement à la frontière où les données entrent dans votre système, avec un message d'erreur clair pointant vers le champ exact qui pose problème.
Générez un schéma automatiquement à partir d'un exemple
Vous n'avez pas à écrire les schémas à la main. Collez une vraie réponse JSON ou un échantillon de données dans notre générateur de schéma JSON et il produit en quelques secondes un schéma draft-07 avec les bons types et les champs requis.
Validez des données contre un schéma
Une fois que vous avez un schéma, utilisez notre validateur de schéma JSON pour vérifier n'importe quel document JSON contre ce schéma. Chaque violation est signalée avec son chemin exact dans le document, pour que vous sachiez précisément ce qui doit être corrigé.
Du schéma vers TypeScript
Si vous travaillez avec TypeScript, notre outil JSON vers TypeScript génère les interfaces correspondantes à partir du même échantillon JSON, vous offrant la sécurité des types à la compilation pour compléter la validation de schéma à l'exécution.
Questions fréquentes
- Quelle version de JSON Schema dois-je utiliser ?
- Draft-07 est la version la plus largement prise en charge et couvre tous les cas d'usage courants. Nos outils génèrent des schémas draft-07. Draft 2019-09 et 2020-12 ajoutent des fonctionnalités principalement pertinentes pour les scénarios de validation avancés.
- JSON Schema peut-il valider des objets imbriqués ?
- Oui — JSON Schema prend pleinement en charge la validation imbriquée. Vous pouvez définir des schémas pour les objets imbriqués à l'aide de
properties, créer des définitions réutilisables, et utiliseranyOfouoneOfpour les valeurs pouvant avoir plus d'une forme valide. - JSON Schema n'est-il utile que pour les API ?
- Pas du tout. JSON Schema est tout aussi utile pour valider les fichiers de configuration, les documents de base de données, les soumissions de formulaires et toute autre donnée structurée que votre application traite.