Konvertálás JSON és YAML között

Ez az eszköz egy YAML dokumentumot JSON-ná alakít át és fordítva, megőrizve az adatszerkezetet (objektumok, tömbök, skalár típusok). A JSON-ból YAML-be, vagy a YAML-ből JSON-ba történő konvertálás gyakori művelet a fejlesztés során: OpenAPI YAML fájlt generálunk egy JSON specifikációból, egy REST API kimenetét YAML-be konvertáljuk, hogy beküldjük egy konfigurációs tárolóba, egy Kubernetes YAML manifesztet JSON-ba fordítunk, hogy átadjuk a kubectl --dry-run=client -o json parancsnak, vagy egy GitHub Actions munkafolyamatot igazítunk egy JSON sémához. Tágabb értelemben ez a híd az adatcsere világa (JSON) és a kézzel szerkeszthető konfiguráció világa (YAML) között.

A JSON és a YAML hasonló igényeket szolgál ki, de eltérő felhasználási esetekben. Az alábbi táblázat összefoglalja a főbb technikai különbségeket, amelyek segítenek a kettő közötti választásban a kontextustól függően.

A JSON-t akkor kell használni, amikor egy program egy másik programmal beszél. Tipikus felhasználási esetei:

• REST és GraphQL API-k: kérés és válasz payloadok.
• Adatcsere mikroszolgáltatások és üzenetsorok között.
• Natív JavaScript kód: JSON.parse és JSON.stringify függőség nélkül.
• Böngészőoldali tárolás: localStorage, sessionStorage, IndexedDB.
• AJAX és fetch kérések.
• Bináris vagy folyamorientált változatok: BSON (MongoDB), JSON Lines (naplók, ML adatkészletek), MessagePack.
• JS / TS eszközök konfigurációja: package.json, tsconfig.json, composer.json.

A YAML-t akkor kell használni, ha egy ember rendszeresen szerkeszti a fájlt. Tipikus felhasználási esetei:

• Docker Compose (docker-compose.yml) és stack profilok.
• Kubernetes manifesztek (Deployment, Service, Ingress, Helm chartok).
• Ansible playbookok és leltárak.
• CI/CD csővezetékek: GitHub Actions, GitLab CI, CircleCI, Bitbucket Pipelines.
• OpenAPI / Swagger és AsyncAPI specifikációk.
• Annotált alkalmazáskonfiguráció (Symfony, Spring Boot, Rails), ahol a megjegyzések hasznosak.
• Gyakran kézzel szerkesztett fájlok, ahol a tömörség és az olvashatóság fontosabb az elemzési sebességnél.

A YAML megengedőbb, mint a JSON, ami erőteljes, de csalóka formátummá teszi. A leggyakoribb csapdák:

• Behúzás: a tabulátorokat a specifikáció tiltja, csak a szóközök érvényesek. A kettő keverése vagy a szóközök számának megváltoztatása ugyanazon a blokkon belül megszakítja az elemzést.
• Skalárok automatikus kényszerítése: yes, no, on, off, true, false, null, None, ~ logikai értékként vagy nullként kerülnek elemzésre. Példa csapda: egy idézőjel nélküli 01234 irányítószám az 1234 egésszé válik, és egy NO országkód (Norvégia) false lesz. Az ambiguus karakterláncokat mindig tegye idézőjelbe.
• Többsoros karakterláncok: a | (blokk literál) megőrzi a sortöréseket úgy, ahogy vannak, míg a > (összehajtott) a sortöréseket szóközökre cseréli. A - és + chomping indikátorok az utolsó sortörés viselkedését állítják be.
• YAML 1.1 vs 1.2: az 1.1 (még mindig elterjedt, például alapértelmezés szerint a PyYAML-en keresztül) a yes/no/on/off-ot logikai értékként kezeli, amit az 1.2 eltávolított. A viselkedés a 8-as alapú számoknál is eltér.
• Implicit dátumok: a 2024-01-15 idézőjelek nélkül egyes elemzők dátum objektumként értelmezik, nem karakterláncként.

Ugyanaz a dokumentum JSON-ban, majd YAML-ben kifejezve. Egy alkalmazás egyszerű konfigurációja függőségeivel és környezetével:

JSON verzió

{
    "name": "cdrn-app",
    "version": "1.14.2",
    "environment": "production",
    "dependencies": {
        "php": "^8.3",
        "symfony/framework-bundle": "^7.0",
        "doctrine/orm": "^3.0"
    },
    "features": ["cache", "mailer", "queue"],
    "debug": false
}

Egyenértékű YAML verzió

# Az alkalmazás konfigurációja
name: cdrn-app
version: 1.14.2
environment: production
dependencies:
    php: '^8.3'
    symfony/framework-bundle: '^7.0'
    doctrine/orm: '^3.0'
features:
    - cache
    - mailer
    - queue
debug: false

A YAML verzió körülbelül 25%-kal rövidebb karakterben, elfogad egy megjegyzést az elején, és úgy olvasható, mint a tulajdonságok listája szintaktikai zaj nélkül.

Az adatok konvertálásának lépései:

1. Illessze be a forrásdokumentumot (JSON vagy YAML) a beviteli mezőbe.
2. Válassza ki a kívánt konverziós irányt (JSON-ból YAML-be, vagy YAML-ből JSON-ba).
3. Kattintson a konvertálás gombra: a formázott eredmény megjelenik a kimeneti területen.
4. Ellenőrizze az eredményt, majd a másolás gombbal másolja az eredményt a vágólapra.

A konvertálás helyben történik a böngészőben vagy egy dedikált szerverútvonalon keresztül az eszközkészlettől függően: nem tárolunk érzékeny adatokat.