Comment ébaucher un JSON Schema à partir de champs documentés
Une ébauche de JSON Schema explicite la structure attendue des données. Elle est utile lorsque la documentation décrit les champs, mais qu'un point de départ de validation lisible par machine est nécessaire.
Commencez avec le bon contenu.
- Ce que vous fournissez
- une spécification de réponse d’API visible.
- Le résultat attendu
- Créez un brouillon de JSON Schema en conservant les champs obligatoires documentés et en signalant les hypothèses.
Comment fonctionne le processus.
Associez les champs documentés à des types et exigences, en gardant les objets imbriqués et les tableaux clairs. Signalez les hypothèses sur les formats, contraintes et dialecte du schéma lorsque la source ne les précise pas.
Les points à vérifier dans le résultat.
Validez le schéma et essayez des exemples connus comme valides et invalides. Ne rendez pas tous les champs documentés obligatoires et n'inventez pas de règles restrictives simplement pour obtenir un schéma bien ordonné.
Analysez le JSON avant de l'utiliser dans une autre application, puis examinez ses valeurs réelles. Une syntaxe valide confirme qu'un analyseur peut lire la structure ; elle ne confirme pas l'exactitude des faits extraits.
Apprenez à partir de l’exemple détaillé.
L'exemple téléchargeable est un objet JSON. Comparez sa structure et son traitement des valeurs manquantes au résultat voulu, puis vérifiez vos propres valeurs à l'aide de la source fournie.
L’exemple fourni est illustratif. Il ne s’agit pas d’une exécution enregistrée sur vos données.
Télécharger l’exemple ↓Utilisez-le avec vos propres contenus.
- Ouvrez la source à utiliser et activez WebAct dans cet onglet.
- Copiez la tâche depuis la section d’introduction, ajoutez les champs ou préférences nécessaires et vérifiez les actions proposées.
- Comparez le premier résultat à votre source. Demandez une correction ou un ajustement précis si nécessaire.