Oblikovalnik JSON in validator JSON sta povezana, vendar ne rešujeta iste težave. Formatiranje olajša branje JSON. Validacija preveri, ali je JSON mogoče razčleniti. Preden delček prilepite v dokumente, konfiguracijsko polje, težavo ali odgovor podpore, boste morda potrebovali eno ali oboje.
Convertyjev JSON/YAML/TOML Converter ohranja ta opravila skupaj: potrdi vnos, ga oblikuj za pregled, zmanjšaj ga, ko je kompakten izhod pomemben, in ga pretvori, ko naslednji sistem pričakuje YAML ali TOML.
Uporabite oblikovalnik, ko je JSON težko brati
Pri oblikovanju gre za predstavitev. Doda zareze in prelome vrstic, tako da je strukturo lažje pregledati.
Uporabite oblikovanje, ko:
- koristni tovor je zmanjšan v eno vrstico
- ugnezdenim objektom je težko slediti
- v dokumentaciji mora biti prikazan primer API-ja
- pregledovalci morajo hitro primerjati polja
- odgovor podpore potrebuje berljiv delček
Oblikovanje ne dokazuje, da je primer pomensko pravilen. Preprosto naredi strukturo vidno.
Uporabite validator, ko je JSON morda neveljaven
Pri validaciji gre za razčlenljivost. Ujame težave s sintakso, kot so manjkajoče vejice, nezaprti nizi, neveljavni narekovaji ali pokvarjeno gnezdenje.
Uporabite preverjanje, preden prilepite JSON v sistem, ki bo zavrnil neveljaven vnos. Uporaben je tudi pred deljenjem primerov, ker neveljavni izrezki zapravljajo čas pregledovalca in naredijo dokumentacijo manj zaupanja vredno.
Uporabite oboje, preden delite pomembne primere
Najvarnejši potek dela je najprej preverjanje, nato pa formatiranje. Če JSON ne razčleni, popravite to, preden skrbite za predstavitev. Ko je veljaven, ga formatirajte, da ga bodo ljudje lahko prebrali.
To zaporedje je še posebej uporabno za primere API-jev. Za osredotočen potek dela za skupno rabo API-ja preberite Kako formatirati JSON pred skupno rabo API-ja, primer.
Ko pride do konverzije
Včasih naslednji sistem potrebuje YAML ali TOML namesto JSON. Pretvorba je tretja naloga, ločena od formatiranja in preverjanja. Spremeni sintakso, hkrati pa poskuša ohraniti strukturo podatkov.
Vsaka struktura se ne preslika čisto v vsak format, zato so opozorila o združljivosti pomembna. Če izhod TOML ni na voljo, preberite Zakaj izhod TOML ni na voljo za nekatere vnose JSON ali YAML.
Odprite JSON/YAML/TOML Converter, ko morate potrditi, formatirati, zmanjšati ali pretvoriti strukturirane podatke, preden jih prilepite v naslednji potek dela.
