Co to jest format pliku YAML?
.yaml to tekstowy format plików służący do wymiany danych między różnymi aplikacjami. YAML - skrót od *YAML Ain't Markup Language* - to standard organizowania informacji w czytelnym dla człowieka, niezależnym od platformy formacie, wykorzystującym pary klucz: wartość oparte na wcięciach, zakodowane w UTF-8. Parsowanie plików .yaml wymaga zainstalowania biblioteki YAML; popularne biblioteki to PyYAML (Python), js-yaml (JavaScript) i SnakeYAML (Java). Pliki .yaml są czasami zapisywane z rozszerzeniem .yml, które jest funkcjonalnie identyczne. Poza wymianą danych, pliki .yaml są zazwyczaj używane do serializacji danych oraz do pisania plików konfiguracyjnych w narzędziach takich jak Docker Compose, Kubernetes i GitHub Actions.
Serializacja
Serializacja to termin używany w informatyce. Jest to proces tłumaczenia danych lub obiektów na format, który może być przechowywany, przesyłany i później rekonstruowany. Na przykład dwie instytucje wymieniające dane w ustandaryzowanym formacie za pomocą różnych aplikacji muszą zserializować te dane przed wysłaniem. Zserializowane dane mogą być również przechowywane w pliku - .yaml, .xml, .json, .toml itp. - a następnie wysyłane do odbiorców.
Dokument .yaml może opcjonalnie zaczynać się od znacznika początku dokumentu --- i kończyć się ...; pozwala to również na umieszczenie wielu dokumentów wewnątrz jednego pliku. Od wersji YAML 1.2 (2009, poprawionej w 2021), każdy poprawny plik JSON jest również poprawnym plikiem YAML.
Bezpieczeństwo
RYZYKO: MEDIUMPlik YAML jest czystym tekstem i nie wykonuje się samodzielnie, więc jego odczyt jest bezpieczny. Istnieją dwa realne zagrożenia: (1) pliki konfiguracyjne YAML (potoki CI, Compose, K8s, Ansible) często zawierają sekrety - tokeny, hasła, klucze - więc nie wklejaj ich do niezaufanych walidatorów online ani nie publikuj w repozytoriach. (2) Niebezpieczeństwo programowe: ładowanie niezaufanego YAML za pomocą niebezpiecznego parsera (np. yaml.load w PyYAML zamiast yaml.safe_load) może wykonać dowolne obiekty/kod - zawsze używaj bezpiecznego ładowania dla plików, którym nie ufasz. Ryzyko edycji: tabulator lub źle wyrównana spacja po cichu zmienia znaczenie, więc po edycji przeprowadź walidację.
Szczegóły formatu
w pigułcePEŁNA NAZWAYAML Ain't Markup Language file
DEWELOPERClark Evans, Ingy döt Net, Oren Ben-Kiki (YAML spec)od 2001 (YAML 1.0); YAML 1.1 (2005); current YAML 1.2 (2009, revised 2021)
KATEGORIAPliki developerskie
TYP MIMEapplication/yaml
TYPCzytelny dla człowieka tekst do serializacji danych (oparty na wcięciach, UTF-8)
STANDARDOtwarty · bezpłatny
Programy otwierające pliki YAML
Windows4 apps
Sublime Text
Freemium Otwórz .yaml do szybkiej edycji z podświetlaniem YAML; skonfiguruj «translate tabs to spaces», aby wcięcia pozostały poprawne. 
Windows Notepad
Wbudowany Otwiera YAML jako tekst do szybkiego podglądu - ale nie pokazuje białych znaków/tabulatorów, więc edycja YAML wrażliwego na wcięcia jest ryzykowna. 
Notepad
Open-source Otwórz z podświetlaniem składni YAML; włącz Widok > Pokaż niewidoczne znaki > Pokaż spacje i tabulatory, aby zachować poprawne wcięcia. 
Visual Studio Code
Darmowy Otwórz plik; wbudowane rozszerzenie YAML od Red Hat zapewnia podświetlanie, prowadnice wcięć, walidację schematów i wskazywanie błędów. Najlepszy wybór dla YAML. 
macOS3 apps
TextEdit
Wbudowany Najpierw wybierz Format > Zamień na czysty tekst i wyłącz inteligentne cudzysłowy - ale program nie pokaże białych znaków, więc do edycji lepiej wybrać edytor kodu.
Visual Studio Code
Darmowy Otwórz plik; wbudowane rozszerzenie YAML od Red Hat zapewnia podświetlanie, prowadnice wcięć, walidację schematów i wskazywanie błędów. Najlepszy wybór dla YAML. 
Sublime Text / BBEdit
Freemium Otwórz .yaml w edytorze kodu, aby uzyskać właściwe podświetlanie YAML i wcięcia oparte na spacjach. 
Linux3 apps
Visual Studio Code
Darmowy Otwórz plik; wbudowane rozszerzenie YAML od Red Hat zapewnia podświetlanie, prowadnice wcięć, walidację schematów i wskazywanie błędów. Najlepszy wybór dla YAML.
GNOME Text Editor / gedit
Open-source Otwórz z podświetlaniem YAML; przed edycją ustaw wstawianie spacji (zamiast tabulatorów).
vim / nano
Open-source Edytuj w terminalu; w Vim użyj «:set expandtab», aby wcięcia używały spacji. Standard dla plików konfiguracyjnych serwera.
Web1 app
YAML Lint / online YAML validators
Darmowy Wklej plik, aby sprawdzić składnię i sformatować go w przeglądarce. Nie wklejaj danych wrażliwych - pliki konfiguracyjne YAML często zawierają poświadczenia. Szczegóły techniczne
specyfikacja| Rozszerzenie pliku | .yaml (również .yml) |
| Typ MIME | application/yaml |
| Kodowanie | Czysty tekst UTF-8; brak binarnego nagłówka lub magicznych bajtów |
| Struktura | Pary klucz: wartość oparte na wcięciach; wcięcia wykorzystują wyłącznie spacje - tabulatory są zabronione przez specyfikację |
| Znaczniki dokumentu | --- oznacza początek dokumentu, ... oznacza koniec dokumentu; wiele dokumentów może współistnieć w jednym pliku |
| Natywne typy danych | Ciągi znaków, liczby całkowite, liczby zmiennoprzecinkowe, wartości logiczne, null, sekwencje (listy), mapowania (słowniki), znaczniki czasu |
| Wersja specyfikacji | YAML 1.2 (2009, poprawiona w 2021); zastępuje YAML 1.1 (2005) i YAML 1.0 (2001) |
| Kompatybilność z JSON | Od wersji YAML 1.2 każdy poprawny dokument JSON jest również poprawnym dokumentem YAML - JSON jest ścisłym podzbiorem |
| Komentarze | Komentarze jednowierszowe wprowadzane przez # ; mogą występować w osobnej linii lub w tej samej linii po wartości |
| Ciągi wielowierszowe | Dosłowny blok skalarny (|) zachowuje znaki nowej linii; złożony blok skalarny (>) zamienia znaki nowej linii na spacje |
| Kotwice i aliasy | & definiuje nazwaną kotwicę, a * odwołuje się do niej (alias), umożliwiając ponowne użycie wartości bez duplikacji |
| Twórcy | Clark Evans, Ingy döt Net, Oren Ben-Kiki |
| Typowe zastosowania | Pliki konfiguracyjne (Kubernetes, Docker Compose, GitHub Actions, Ansible), serializacja danych, definicje OpenAPI |
| Cudzysłowy | Obsługiwane są ciągi bez cudzysłowów, w pojedynczych cudzysłowach ('...') oraz w podwójnych cudzysłowach ("..."); podwójne cudzysłowy pozwalają na sekwencje ucieczki |
| Wydano | 2001 (YAML 1.0); YAML 1.1 (2005); current YAML 1.2 (2009, revised 2021) |
| Otwarty standard | Tak · bezpłatny (royalty-free) |
| Specyfikacja | yaml.org |
Konwersje YAML
Możliwa
.YAML .JSONPRZEWODNIK
Tak - YAML i JSON współdzielą ten sam model danych, więc konwersja jest bezstratna; usuwane są jedynie…
Jak konwertować
.YAML .XMLPRZEWODNIK
Tak - zarówno YAML, jak i XML opisują dane hierarchiczne, więc konwersja jest prosta, choć każdy klucz YAML…
Jak konwertować
.YAML .TOMLPRZEWODNIK
Tak, YAML można przekonwertować na TOML - najszybszą metodą jest jedno polecenie yq: yq -o=toml file.yaml >…
Jak konwertować
.YAML .CSVPRZEWODNIK
Tak - ale tylko wtedy, gdy plik .yaml jest płaską, jednolitą listą rekordów; zagnieżdżone konfiguracje, takie…
Jak konwertować
.YAML .YMLPRZEWODNIK
Tak - .yaml i .yml to ten sam format; zmiana nazwy pliku to wszystko, co musisz zrobić.
Jak konwertować
Niemożliwa
Pytania i odpowiedzi społeczności
pytania użytkowników
I
Najczęściej zadawane pytania
Jaka jest różnica między .yaml a .yml?
Żadna - to ten sam format YAML z dwoma rozszerzeniami. .yml to starsza, 3-literowa forma. Używaj tego, którego oczekuje dane narzędzie; możesz po prostu zmienić nazwę pliku.
Jak otworzyć plik .yaml?
Za pomocą dowolnego edytora kodu lub tekstu. VS Code (z rozszerzeniem YAML) jest najlepszy, ponieważ podświetla strukturę i sygnalizuje błędy wcięć; Notepad++ i Sublime również się sprawdzą. To zwykły tekst, więc Notepad go otworzy - ale nie pokaże białych znaków, które są kluczowe dla YAML.
Dlaczego mój YAML zgłasza błąd wcięcia/parsowania?
YAML używa spacji do struktury i zabrania używania tabulatorów, więc zabłąkany tabulator lub źle wyrównana linia psuje go. Otwórz go w edytorze obsługującym YAML (pokaż białe znaki, konwertuj tabulatory na spacje) lub wklej go do walidatora YAML online, aby znaleźć dokładną linię.
Jak przekonwertować YAML na JSON?
Użyj polecenia «yq -o=json file.yaml», komendy w VS Code lub konwertera online. Jest to proces zasadniczo bezstratny, ponieważ JSON jest podzbiorem YAML - usuwane są tylko komentarze.
Czy mogę używać tabulatorów w YAML?
Nie. YAML pozwala wyłącznie na spacje w celu tworzenia wcięć; tabulatory powodują błąd parsowania. Ustaw edytor tak, aby wstawiał spacje (np. «:set expandtab» w Vim lub «translate tabs to spaces» w Sublime).
Czy YAML jest tylko dla języka Python?
Nie - to powszechne błędne przekonanie. YAML jest niezależny od języka i jest używany wszędzie: Docker Compose, Kubernetes, GitHub Actions, Ansible, aplikacje Go/Java/JS i inne. Python po prostu posiada popularną bibliotekę YAML (PyYAML).
Źródła
1YAML 1.2.2 Specification (yaml.org)yaml.org
2yaml.org - official site & resourcesyaml.org
