Outils YAML dans XMLSpy

Éditeur et validateur YAML

  • Mise en surbrillance de la syntaxe
  • Vérification de bonne formation de YAML
  • Mode Grille YAML
  • Validation de YAML par rapport au schéma JSON/schéma YAML
  • Prise en charge des schémas YAML
  • Interroger YAML avec XQuery
  • Convertir YML en JSON/XML
  • Convertir XML en YAML
  • Convertir JSON en YAML
  • Générer schéma JSON depuis YAML
  • Générer schéma YAML depuis YAML
  • Convertir XSD en schéma YAML

Avantages de YAML

Abrégé pour « YAML Ain't Markup Language », YAML est un format de sérialisation directement lisible qui est utilisé généralement pour les fichiers de configuration, l’échange de données et la programmation de l’application. La plupart des langages de programmation fournissent des bibliothèques ou une prise en charge intégrée pour le parsage YAML. Il est conçu pour être facile à lire et à écrire, ce qui en fait un excellent choix pour les configurations nécessitant un traitement manuel.

L’un des avantages primaires de YAML est sa simplicité et sa flexibilité. YAML utilise l’indentation et les deux-points pour définir les structures hiérarchiques, le rendant concis et facile à comprendre. Il prend en charge une variété de types de données, y compris des scalaires (chaînes, nombres, booléens), séquences (listes), et des mappages (paires clé-valeur). YAML prend également en charge des ancres et des alias, qui permettent la réutilisation des données et la représentation efficace de structures de données complexes.

Les fichiers YAML ont généralement l’extension .yaml ou .yml.

Éditeur YAML : Mode Texte

Éditeur YAML dans XMLSpy

De nombreuses applications et systèmes utilisent une combinaison de XML, JSON, et YAML pour des fichiers de configuration, des échanges de données et des API payloads.

Outre l'édition YAML, XMLSpy offre une excellente gestion des formats XML et JSON. La prise en charge de tous ces formats dans un seul éditeur offre aux développeurs la flexibilité nécessaire pour travailler avec des fichiers provenant de différentes sources et les intégrer facilement dans leurs projets.

Les outils YAML XMLSpy comprennent :

  • Édition de YAML avec mise en évidence de la syntaxe
  • Pliage de la source et numéros de ligne
  • Vérification de la bonne formation
  • Validateur YAML
  • Génération de schéma depuis un document YAML
  • Convertisseur YAML en un seul clic

Mode Grille YAML

Outre son éditeur de texte, XMLSpy inclut un Mode Grille pour l’édition de documents YAML de manière visuelle. La Grille YAML sera immédiatement familière aux développeurs qui utilisent les modes Grille XML et Grille JSON de XMLSpy.

Le Mode YAML fournit une représentation graphique de la structure du document qui est tout de suite plus facile à comprendre que le code correspondant dans le mode texte. Le Mode Grille vous permet d’interagir avec les données YAML dans un format plus convivial, réduisant les erreurs qui pourraient apparaître en raison de l’édition manuelle des fichiers YAML en format brut (comme l’indentation désalignée). La possibilité d'agrandir et de réduire certaines sections des données YAML facilite la navigation dans les fichiers volumineux et la localisation d'éléments spécifiques.

Éditeur visuel YAML dans XMLSpy

Les outils innovants comme le mode table (affiché dans la zone sélectionnée ci-dessus) et les filtres XPath/XQuery rendent le Mode YAML particulièrement utile. De plus, le Mode Grille propose une multitude d'outils qui facilitent l’utilisation de YAML :

  • La structure du document YAML peut être simplement modifiée en ajoutant, supprimant, ou déplaçant les objets dans la grille. Des blocs entiers de texte peuvent être réorganisés rapidement (par exemple, en les triant ou en les déplaçant).
  • Le contenu peut être facilement édité dans le Mode Grille, notamment à l’aide des commandes intégrées dans chaque cellule.
  • Le Mode Table permet d'afficher un nœud avec ses nœuds descendants sous forme de tableau pour une meilleure compréhension, chaque objet descendant étant affiché dans une ligne distincte. Vous pouvez activer et désactiver le Mode Table pour adapter le contenu.
  • Les fonctionnalités d'affichage vous permettent de déterminer rapidement la relation entre un alias et une ancre.
  • Les filtres et les formules peuvent être utilisés pour filtrer et traiter les données selon les besoins.
  • Le contenu peut être édité visuellement à l'aide du glisser-déposer et des menus contextuels des types de données.

Validateur YAML

Puisque la spécification YAML n’inclut pas de schéma, XMLSpy prend en charge la validation des documents YAML par rapport aux schémas JSON en ce qui concerne la cohérence des données et la vérification d’erreurs. La validation est possible aussi bien avec des schémas JSON classiques qu’avec des schémas YAML (écrits en syntaxe YAML, mais reposant sur les règles JSON). Les schémas JSON et YAML peuvent être facilement modifiés dans l’Éditeur graphique de schémas JSON de XMLSpy.

Vous pouvez attribuer un schéma à votre document YAML dans l’onglet JSON de la fenêtre d’informations XMLSpy. Une fois la validation effectuée, les résultats seront mis en évidence dans le document et les détails s'afficheront dans la fenêtre Messages. Un simple clic sur une erreur dans cette fenêtre permet de l’atteindre directement dans le fichier pour la corriger.

Conversion YAML

Afin d'assurer la compatibilité et l'interopérabilité, XMLSpy prend en charge la conversion en un seul clic entre les formats YAML, XML et JSON.

Ceci inclut la conversion :

  • JSON en YAML
  • XML en YAML
  • YAML en JSON/XML
  • YAML en schéma JSON
  • YAML en schéma YAML
  • Schéma XML (XSD) en schéma YAML
Convertir JSON en YAML dans XMLSpy

XMLSpy peut générer un schéma JSON ou un schéma YAML à partir d'une instance YAML. Cette fonction est particulièrement utile, car elle vous fournit rapidement un schéma basé sur un document YAML existant, vous évitant ainsi le travail associé à la création manuelle d'un schéma à partir de zéro. Vous pouvez modifier ou élargir le schéma généré selon vos exigences.

Interroger YAML avec XQuery

Contrairement à XML, JSON et YAML ne possèdent pas de langage de requête officiel. Cependant, JSON peut être interrogé à l’aide d’expressions XPath/XQuery 3.1, et XMLSpy étend cette même fonctionnalité aux documents YAML via la fenêtre XPath/XQuery.

Pour démarrer rapidement, placez-vous sur un emplacement cible dans le fichier YAML actif et choisissez Copier XPath dans le menu contextuel. Collez ensuite cette expression dans le volet Générateur XPath/XQuery, qui servira de point de départ. Pour modifier l’expression, le générateur XPath/XQuery propose l’auto-complétion et une fonction de création d’expressions par pointer-cliquer à partir d’une liste complète d’opérateurs, d’expressions et de fonctions intégrées.

Pendant que vous travaillez, l’évaluateur renvoie les résultats de votre expression XQuery, ce qui vous permet de tester et d’ajuster votre travail.

Utiliser XQuery pour interroger un document YAML

La prise en charge de XQuery appliqué à YAML constitue une autre fonctionnalité innovante, exclusive à XMLSpy.