JSON schemos vadovas
Prieš pereinant prie JSON schemos, svarbu žinoti skirtumą tarp JSON ir JSON schemos.
JSON
JSON yra trumpinys „JavaScript Object Notation“ ir tai nuo kalbos nepriklausomas duomenų formatas, kurį API naudoja užklausoms ir atsakymams siųsti. JSON paprasta skaityti ir rašyti žmonėms ir įrenginiams. JSON yra teksto formatas, nesusietas su kalba (nepriklausoma nuo kalbos).
JSON schema
JSON schema yra naudingas įrankis JSON duomenų struktūrai patikrinti. Norėdami nurodyti JSON struktūrą, naudokite JSON pagrįstą formatą. Jo tikslas – užtikrinti, kad JSON duomenys būtų priimtini. Mūsų programos JSON duomenų susitarimas gali būti apibrėžtas naudojant schemą.
JSON schemos specifikaciją sudaro trys pagrindiniai skyriai:
JSON hiperschema:
JSON Hyper-Schema yra JSON schemos kalba, kuri gali būti naudojama žymėti JSON dokumentus su hipersaitais ir instrukcijomis, kaip apdoroti ir keisti išorinius JSON išteklius naudojant tekstinę aplinką, pvz., HTTP. Spustelėkite čia Norėdami sužinoti daugiau apie JSON hiperschemą.
JSON schemos branduolys:
Tai yra JSON dokumentų žymėjimo ir patvirtinimo taisyklių rinkinys.
JSON schemos branduolys:
- Aprašomas šiuo metu turimas duomenų formatas.
- Patvirtina duomenis, kurie gali būti naudojami atliekant automatinį testavimą.
- Klientų pateiktų duomenų tikslumo užtikrinimas.
- Pateikiama skaitoma dokumentacija ir žmonėms, ir mašinoms.
JSON schemos patvirtinimas:
Patvirtinimas, pagrįstas JSON schema, nustato egzempliorių duomenų struktūros apribojimus. Po to visi raktiniai žodžiai, neturintys tvirtinimo informacija, pvz., aprašomieji metaduomenys ir naudojimo nuorodos, pridedami prie egzemplioriaus pozicijos, kuri atitinka visus deklaruotus apribojimus.
Newtonsoft JSON schemos tikrinimo įrankis yra įrankis, kurį galite nemokamai naudoti tiesiogiai naršyklėje. Naudodami šį įrankį galite išbandyti JSON schemos struktūrą. Šiame puslapyje yra valdiklių ir paaiškinimų, kad galėtumėte pradėti. Tokiu būdu nesunku suprasti, kaip patobulinti JSON struktūrą.
JSON objektą galime patikrinti naudodami JSON schemos patvirtinimo įrankį:
Turime amžiaus patvirtinimą (minimalus = 20 ir maksimalus = 40), kaip parodyta aukščiau esančiame paveikslėlyje. Klaidų nerasta.
Jei amžiaus patvirtinimas buvo įvestas neteisingai, buvo rodoma klaida.
JSON schemos kūrimas
Pažvelkime į JSON schemos pavyzdį, kad pamatytumėte, apie ką kalbame. Pagrindinis JSON objektas, apibūdinantis produktų katalogą, yra toks:
Jo JSON schema gali būti parašyta taip:
JSON schema yra JSON dokumentas ir tas dokumentas TURI būti objektas. Raktiniai žodžiai yra objekto nariai / atributai, nurodyti JSON schemos. „Raktiniai žodžiai“ JSON schemoje reiškia objekto rakto / vertės derinio „rakto“ dalį. JSON schemos rašymas apima tam tikro „raktažodžio“ susiejimą su objektu esančia verte.
Pažvelkime atidžiau į pavyzdyje naudotus raktinius žodžius:
JSON schema, kurią atitinka ištekliaus schema, įrašoma šiuo atributu. Ši schema parašyta pagal juodraščius v4 standartą, kaip nurodyta „$ schema“ raktinį žodį. Tai neleis jūsų schemai grįžti į dabartinę versiją, kuri gali būti suderinama arba nesuderinama su senesne versija.
"pavadinimas"Ir"aprašymas” raktiniai žodžiai yra tik paaiškinamieji; jie nenustato jokių apribojimų tikrinamiems duomenims. Šie du raktiniai žodžiai apibūdina schemos tikslą: ji apibūdina produktą.
"tipas“ raktinis žodis apibrėžia mūsų JSON duomenų pirmąją ribinę sąlygą; tai turi būti JSON objektas. Jei nenustatysime tipo visoms schemoms, kodas neveiks. Kai kurie įprasti tipai yra „skaičius“, „Bulio vertė“, „sveikasis skaičius“, „nulis“, „objektas“, „masyvas“ „eilutė“.
JSON schemą palaiko šios bibliotekos:
Pasirinkite kalbą | Biblioteka |
C | WJElement |
Pitonas | jschon |
PHP | Json schemos variantas |
JavaScript | ajv |
Go | gojsonschema |
Kotlinas | Medėja-validatorius |
rubinas | JSONSchemer |
JSON (sintaksė)
Trumpai pažvelkime į pagrindinę JSON sintaksę. JSON sintaksė yra „JavaScript“ sintaksės poaibis, kurį sudaro šie elementai:
- Naudojamos vardo/reikšmių poros, kurios atspindi duomenis.
- Objektai laikomi riestiniuose skliaustuose, o kiekvienas pavadinimas yra priešais ':' (dvitaškis), o verčių poros atskirtos "," (kableliu).
- Reikšmės atskiriamos "," (kableliais), o masyvai pateikiami laužtiniuose skliaustuose.
JSON palaiko šias dvi duomenų struktūras:
- Sutvarkytas vertybių sąrašas: Tai gali būti masyvas, sąrašas arba vektorius.
- Vardo/reikšmių porų rinkinys: Šią duomenų struktūrą palaiko įvairios kompiuterių kalbos.
JSON (objektas)
JSON schema yra JSON objektas, apibūdinantis kito JSON objekto tipą ir struktūrą. „JavaScript“ objekto išraiška gali atstovauti JSON objektui „JavaScript“ vykdymo aplinkose. Kai kurie galiojančių schemų objektų pavyzdžiai yra tokie:
Schema | Degtukai |
{} | bet kokią vertę |
{ tipas: 'objektas' } | „JavaScript“ objektas |
{ type: 'number' } | „JavaScript“ numeris |
{ type: 'string'} | „JavaScript“ eilutė |
Pvz .:
Sukurkite naują tuščią objektą:
var JSON_Obj = {};
Naujo objekto kūrimas:
var JSON_Obj = naujas objektas ()
JSON (palyginimas su XML)
JSON ir XML yra nuo kalbos nepriklausomi žmogaus skaitomi formatai. Realiame pasaulyje jie gali kurti, skaityti ir iššifruoti. Remdamiesi šiais kriterijais, galime palyginti JSON su XML.
sudėtingumas
Kadangi XML yra sudėtingesnis nei JSON, programuotojai teikia pirmenybę JSON.
Masyvų naudojimas
XML naudojamas struktūriniams duomenims išreikšti; tačiau XML nepalaiko masyvų, bet JSON palaiko.
Analizuojama
JSON interpretuojamas naudojant JavaScript eval funkciją. eval grąžina aprašytą objektą, kai naudojamas su JSON.
Pavyzdys:
JSON | XML |
{ „Įmonė“: „Ferrari“, „vardas“: „GTS“, "kaina": 404000 } |
Ferrari
GTS
404000 XNUMX
|
JSON schemos pranašumai
JSON sukurtas taip, kad būtų nukreiptas žmogaus ir mašinų skaitoma kalba. Tačiau be tam tikro patikslinimo tai negali būti nei vienas, nei kitas. JSON schema turi pranašumą, nes JSON tampa suprantamesnė tiek mašinoms, tiek žmonėms.
Naudojant JSON schemą taip pat nebereikia kelių kliento naujinimų. Įprastų HTML kodų sąrašo sudarymas ir jų įdiegimas kliento pusėje yra tipiškas, bet netikslus būdas sukurti kliento pusėje. API programėlės. Tačiau tai nėra pati geriausia strategija, nes serverio pusės pakeitimai gali sukelti tam tikrų funkcijų gedimą.
Pagrindinis JSON schemos privalumas yra jos suderinamumas su įvairiomis programavimo kalbomis, taip pat patvirtinimo tikslumas ir nuoseklumas.
JSON schema palaiko daugybę naršyklių ir Operacinės sistemos, todėl JSON parašytoms programoms nereikia daug pastangų, kad jos visos būtų suderinamos su naršykle. Kurdami kūrėjai atsižvelgia į kelias naršykles, nors JSON jau turi tokias galimybes.
JSON yra efektyviausias būdas dalytis bet kokio dydžio duomenimis, įskaitant garsą, vaizdo įrašą ir kitą laikmeną. Taip yra dėl to, kad JSON duomenis saugo masyvuose, o tai palengvina duomenų perdavimą. Todėl JSON yra geriausias internetinių API ir kūrimo failų formatas.
Kadangi API tampa vis dažnesnė, logiška manyti, kad API patvirtinimas ir testavimas taps vis svarbesnis. Taip pat realu tikėtis, kad laikui bėgant JSON greičiausiai netaps daug paprastesnis. Tai reiškia, kad duomenų schemos turėjimas laikui bėgant taps dar svarbesnis. Kadangi JSON yra standartinis failo formatas dirbant su API, JSON schema yra geras pakaitalas tiems, kurie dirba su API.
