A JSON-formázó és a JSON-ellenőrző kapcsolódnak egymáshoz, de nem oldják meg ugyanazt a problémát. A formázás megkönnyíti a JSON olvasását. Az érvényesítés ellenőrzi, hogy a JSON értelmezhető-e. Mielőtt beillesztene egy kódrészletet a dokumentumokba, egy konfigurációs mezőbe, egy problémába vagy egy támogatási válaszba, szüksége lehet az egyikre vagy mindkettőre.
A Converty JSON / YAML / TOML Converter egyben tartja ezeket a feladatokat: érvényesíti a bemenetet, formázza ellenőrzésre, kicsinyíti, ha a kompakt kimenet számít, és konvertálja, amikor a következő rendszer YAML-t vagy TOML-t vár.
Használjon formázót, ha a JSON nehezen olvasható
A formázás a prezentációról szól. Behúzásokat és sortöréseket ad hozzá, így a szerkezet könnyebben ellenőrizhető.
Használja a formázást, ha:
- a hasznos teher egy sorba van minimalizálva
- a beágyazott objektumokat nehéz követni
- API-példát kell mutatni a dokumentációban
- a bírálóknak gyorsan össze kell hasonlítaniuk a mezőket
- a támogatási válaszhoz egy olvasható részletre van szükség
A formázás nem bizonyítja, hogy a példa szemantikailag helyes. Egyszerűen láthatóvá teszi a szerkezetet.
Használjon érvényesítőt, ha a JSON érvénytelen
Az érvényesítés az értelmezhetőségről szól. Elkapja a szintaktikai problémákat, például a hiányzó vesszőket, a be nem zárt karakterláncokat, az érvénytelen idézőjeleket vagy a hibás beágyazást.
Használjon érvényesítést, mielőtt beilleszti a JSON-t egy olyan rendszerbe, amely elutasítja az érvénytelen bevitelt. Példák megosztása előtt is hasznos, mert az érvénytelen kivonatok időt veszítenek az ellenőrző számára, és kevésbé megbízhatóak a dokumentációban.
Használja mindkettőt, mielőtt fontos példákat osztana meg
A legbiztonságosabb munkafolyamat először az érvényesítés, majd a formázás. Ha a JSON nem értelmezhető, javítsa ki, mielőtt aggódna a megjelenítés miatt. Ha érvényes, formázza úgy, hogy az emberek is elolvashassák.
Ez a szekvencia különösen hasznos API-példák esetén. A fókuszált API-megosztási munkafolyamathoz olvassa el a JSON formázása API-példa megosztása előtt című részt.
Amikor a konverzió belép a képbe
Néha a következő rendszernek YAML-re vagy TOML-re van szüksége a JSON helyett. A konvertálás egy harmadik feladat, amely elkülönül a formázástól és az érvényesítéstől. Megváltoztatja a szintaxist, miközben megpróbálja megőrizni az adatstruktúrát.
Nem minden struktúra illeszkedik tisztán minden formátumhoz, ezért számítanak a kompatibilitási figyelmeztetések. Ha a TOML-kimenet nem érhető el, olvassa el a Miért nem érhető el a TOML-kimenet egyes JSON- vagy YAML-bemeneteknél című részt.
Nyissa meg a JSON / YAML / TOML konvertert, ha ellenőriznie kell, formáznia, kicsinyítenie vagy konvertálnia kell a strukturált adatokat, mielőtt beilleszti őket a következő munkafolyamatba.
