Narzędzia YAML w programie XMLSpy

Edytor i walidator plików YAML

  • Podświetlanie składni
  • Sprawdzanie poprawności składni plików YAML
  • Widok siatki YAML
  • Sprawdź poprawność pliku YAML w oparciu o schemat JSON lub schemat YAML
  • Wsparcie dla schematów YAML
  • Zapytania YAML z wykorzystaniem XQuery
  • Konwertuj pliki YAML na format JSON lub XML
  • Konwertuj pliki XML na format YAML
  • Konwertuj JSON na YAML
  • Generowanie schematu JSON na podstawie pliku YAML
  • Wygeneruj schemat YAML na podstawie pliku YAML
  • Konwertuj schemat XSD na format YAML

Zalety formatu YAML

Skrót od "YAML Ain't Markup Language", czyli "YAML to nie język znaczników" YAML YAML to format serializacji danych, który jest czytelny dla człowieka i powszechnie stosowany do plików konfiguracyjnych, wymiany danych oraz programowania aplikacji. Większość języków programowania oferuje biblioteki lub wbudowane wsparcie do parsowania plików YAML. Jest on zaprojektowany tak, aby był łatwy do odczytu i zapisu, co czyni go doskonałym wyborem dla konfiguracji, które muszą być edytowane przez ludzi.

Jedną z głównych zalet YAML jest jego prostota i elastyczność. YAML wykorzystuje wcięcia i dwukropki do definiowania struktur hierarchicznych, co sprawia, że jest zwięzły i łatwy do zrozumienia. Obsługuje różne typy danych, w tym skale (łańcuchy znaków, liczby, wartości logiczne), sekwencje (listy) oraz mapowania (pary klucz-wartość). YAML obsługuje również kotwice i aliasy, które umożliwiają ponowne wykorzystanie danych i pozwalają na efektywne reprezentowanie złożonych struktur danych.

Pliki YAML zazwyczaj mają rozszerzenie .yaml lub .yml.

Edytor YAML: Widok tekstowy

Edytor YAML w programie XMLSpy

Wiele nowoczesnych aplikacji i systemów wykorzystuje kombinację formatów XML, JSON i YAML do tworzenia plików konfiguracyjnych, wymiany danych oraz przesyłania danych w interfejsach API.

Oprócz edycji plików YAML, XMLSpy oferuje rozbudowane wsparcie dla formatów XML i JSON. Obsługa wszystkich tych formatów w jednym edytorze daje programistom elastyczność pracy z plikami pochodzącymi z różnych źródeł oraz umożliwia ich bezproblemową integrację z projektami.

Narzędzia XMLSpy do obsługi formatu YAML obejmują:

  • Edycja plików YAML z podświetlaniem składni
  • Zwijanie kodu i numery linii
  • Sprawdzanie poprawności składni
  • Walidator YAML
  • Generowanie schematu na podstawie dokumentu YAML
  • Konwerter YAML działający w jednym kliknięciu

Widok siatki YAML

Oprócz edytora tekstu, XMLSpy zawiera widok tabelaryczny (Grid View) umożliwiający edycję dokumentów YAML w sposób wizualny. Interfejs tego widoku tabelarycznego będzie natychmiast znajomy programistom, którzy korzystają z widoków XML Grid i JSON Grid.

Widok siatki YAML zapewnia graficzną reprezentację struktury dokumentu, co ułatwia zrozumienie w porównaniu do odpowiadającego mu kodu wyświetlanego w formie tekstowej. Widok siatki umożliwia interakcję z danymi YAML w bardziej przyjaznym dla użytkownika formacie, co zmniejsza ryzyko błędów, które mogą wystąpić podczas ręcznej edycji surowych plików YAML (np. nieprawidłowe wcięcie). Możliwość rozwijania i zwijania sekcji danych YAML ułatwia nawigację po dużych plikach i lokalizowanie konkretnych elementów.

Edytor YAML z interfejsem graficznym w programie XMLSpy

Innowacyjne narzędzia, takie jak tryb tabelaryczny (pokazany na zaznaczonym obszarze powyżej) oraz filtry XPath/XQuery, sprawiają, że YAML Grid jest szczególnie przydatny, a widok siatki (Grid View) oferuje szereg narzędzi, które ułatwiają pracę z formatem YAML:

  • Strukturę dokumentu YAML można łatwo modyfikować, dodając, usuwając lub przemieszczając elementy w siatce. Całe bloki tekstu można szybko reorganizować (na przykład poprzez sortowanie lub przesuwanie).
  • Treść można łatwo edytować w widoku siatki, szczególnie korzystając z poleceń dostępnych wewnątrz poszczególnych komórek.
  • Tryb tabeli umożliwia wyświetlanie węzła wraz z jego podwęzłami w formie tabeli, co ułatwia zrozumienie struktury. Każdy podwęzeł jest wyświetlany w oddzielnym wierszu. Można włączać i wyłączać tryb tabeli, dostosowując go do prezentowanych danych.
  • Funkcje wyświetlania pomagają szybko określić związek między aliasem a punktem odniesienia.
  • Filtry i formuły mogą być wykorzystywane do filtrowania i przetwarzania danych w zależności od potrzeb.
  • Zawartość można edytować wizualnie, za pomocą przeciągania i upuszczania oraz poprzez menu kontekstowe związane z typem danych.

Walidator YAML

Ponieważ specyfikacja YAML nie zawiera schematu, XMLSpy umożliwia weryfikację dokumentów YAML w odniesieniu do schematów JSON, co zapewnia spójność danych i wykrywanie błędów. Obsługiwane są zarówno tradycyjne schematy JSON, jak i schematy YAML, które są schematami JSON zapisanymi w składni YAML. Schematy JSON i YAML można łatwo edytować w interfejsie graficznym XMLSpy Edytor schematów JSON.

Można przypisać schemat do dokumentu YAML w zakładce JSON okna informacyjnego XMLSpy. Po weryfikacji, wyniki zostaną wyróżnione w dokumencie, a szczegóły zostaną wyświetlone w oknie komunikatów. Można kliknąć błąd w oknie komunikatów, aby przejść do tego błędu w dokumencie i szybko go rozwiązać.

Konwertuj plik YAML

Aby zapewnić kompatybilność i możliwość wymiany danych, program XMLSpy umożliwia konwersję między formatami YAML, XML i JSON za pomocą jednego kliknięcia.

Obejmuje to konwersję:

  • Konwersja z formatu JSON do formatu YAML
  • Konwersja z formatu XML do formatu YAML
  • Konwersja z formatu YAML do formatów JSON lub XML
  • Konwersja z formatu YAML do schematu JSON
  • Konwersja z formatu YAML do schematu YAML
  • Konwersja schematu XML (XSD) na schemat YAML
Konwersja formatu JSON na YAML w programie XMLSpy

XMLSpy może generować schemat JSON lub schemat YAML na podstawie istniejącego pliku YAML. Ta funkcja jest bardzo przydatna, ponieważ pozwala szybko uzyskać schemat oparty na istniejącym dokumencie YAML, oszczędzając czas i wysiłek związany z ręcznym tworzeniem schematu od podstaw. Następnie można zmodyfikować lub rozszerzyć wygenerowany schemat, dostosowując go do własnych potrzeb.

Wyszukiwanie danych w formacie YAML za pomocą XQuery

W przeciwieństwie do XML, formaty JSON i YAML nie posiadają oficjalnego języka zapytań. Jednak zapytania do JSON można formułować za pomocą wyrażeń XPath/XQuery 3.1, a program XMLSpy udostępnia tę samą funkcjonalność również dla dokumentów YAML w oknie XPath/XQuery.

Aby szybko rozpocząć, należy wskazać żądane miejsce w aktywnym pliku YAML i wybrać opcję "Kopiuj ścieżkę XPath" z menu kontekstowego. Następnie należy wkleić tę ścieżkę do panelu konstruktora XPath/XQuery jako punkt wyjścia. Konstruktor XPath/XQuery umożliwia modyfikowanie wyrażenia za pomocą automatycznego uzupełniania oraz budowania wyrażeń poprzez interaktywne wybieranie z obszernej listy operatorów, wyrażeń i wbudowanych funkcji.

Podczas pracy, narzędzie do oceny (Evaluator) wyświetla wyniki wyrażenia XQuery, dzięki czemu można je przetestować i udoskonalić.

Użyj języka XQuery do wykonywania zapytań do dokumentu YAML

Możliwość wykorzystania języka XQuery do przetwarzania plików YAML to kolejna innowacyjna funkcja, która wyróżnia program XMLSpy.