JSON-skeemi juhend
Enne JSON-skeemiga tutvumist on oluline teada JSON-i ja JSON-skeemi erinevust.
JSON
JSON on lühend sõnast JavaScript Object Notation ja see on keelest sõltumatu andmevorming, mida API-d kasutavad päringute ja vastuste saatmiseks. JSON-i on lihtne lugeda ja kirjutada nii inimestele kui ka masinatele. JSON on tekstipõhine vorming, mis ei ole keelega seotud (keelest sõltumatu).
JSON-skeem
JSON-skeem on kasulik tööriist JSON-i andmestruktuuri kontrollimiseks. JSON-i struktuuri määramiseks kasutage JSON-põhist vormingut. Selle eesmärk on tagada, et JSON-andmed on vastuvõetavad. Meie rakenduse JSON-andmete tava võib määratleda skeemi abil.
JSON-skeemi spetsifikatsioonil on kolm peamist jaotist.
JSON-hüperskeem:
JSON Hyper-Schema on JSON-skeemi keel, mida saab kasutada JSON-dokumentide märgistamiseks hüperlinkide ja juhistega väliste JSON-ressursside töötlemiseks ja muutmiseks tekstipõhiste keskkondade (nt HTTP) kaudu. Klõpsake siin JSON Hyper-Schema kohta lisateabe saamiseks.
JSON-skeemi tuum:
See on JSON-dokumentide märgistamise ja valideerimise reeglite kogum.
JSON-skeemi tuum:
- Kirjeldab praegu kasutatavat andmevormingut.
- Kinnitab andmed, mida saab kasutada automatiseeritud testimisel.
- Klientide esitatud andmete õigsuse tagamine.
- Pakub loetavat dokumentatsiooni nii inimestele kui ka masinatele.
JSON-skeemi valideerimine:
JSON-skeemil põhinev valideerimine seab eksemplari andmete struktuurile piirangud. Pärast seda kõik märksõnad, millel pole väidet info, nagu kirjeldavad metaandmed ja kasutusnäidised, lisatakse eksemplari positsioonile, mis vastab kõigile deklareeritud piirangutele.
Newtonsofti JSON Schema Validator tööriist on tööriist, mida saate otse brauseris tasuta kasutada. Selle tööriista abil saate testida oma JSON-skeemi struktuuri. Sellel lehel on alustamiseks juhtelemendid ja selgitused. Nii on lihtne mõista, kuidas oma JSON-i struktuuri parandada.
Saame oma JSON-objekti kontrollida JSON-skeemi valideerimistööriista abil:
Meil on vanuse kinnitamine (minimaalne = 20 ja maksimaalne = 40), nagu on näidatud ülaltoodud joonisel. Vigu ei leitud.
Kui vanuse kinnitus oli valesti sisestatud, kuvatakse tõrge.
JSON-skeemi loomine
Vaatame JSON-skeemi näidet, et näha, millest me räägime. Tootekataloogi kirjeldav põhiline JSON-objekt on järgmine:
Selle JSON-skeem võib olla kirjutatud järgmiselt:
JSON-skeem on JSON-dokument ja see dokument PEAB olema objekt. Märksõnad on JSON Schema määratud objekti liikmed/atribuudid. JSON-skeemi „märksõnad” viitavad võtme/väärtuse kombinatsiooni võtmeosale objektis. JSON-skeemi kirjutamine hõlmab enamasti konkreetse märksõna vastendamist objektis oleva väärtusega.
Vaatame üksikasjalikumalt näites kasutatud märksõnu:
Selle atribuudi abil kirjutatakse üles JSON-skeem, millele ressursi skeem järgib. See skeem on kirjutatud standardi v4 mustandite järgi, nagu on täpsustatud "skeem $” märksõna. See takistab teie skeemi naasmist praegusele versioonile, mis võib vanema versiooniga ühilduda või mitte.
"pealkiri"Ja"kirjeldus” märksõnad on vaid selgitavad; need ei sea kontrollitavatele andmetele mingeid piiranguid. Need kaks märksõna kirjeldavad skeemi eesmärki: see kirjeldab toodet.
"tüüp” märksõna määratleb meie JSON-andmete esimese piirtingimuse; see peab olema JSON-objekt. Kui me ei määra kõigi skeemide tüüpi, siis kood ei töötaks. Mõned levinumad tüübid on "number", "tõuväärtus", "täisarv", "null" "objekt" "massiivne" "string".
JSON-skeemi toetavad järgmised teegid:
| Keel | Raamatukogu |
| C | WJElement |
| Python | jschon |
| PHP | Opis Json Schema |
| JavaScript | ajv |
| Go | gojsonschema |
| Kotlin | Medeia-validaator |
| rubiin | JSON-skeem |
JSON (süntaks)
Vaatame lühidalt JSON-i põhisüntaksit. JSON-i süntaks on JavaScripti süntaksi alamhulk, mis sisaldab järgmisi elemente.
- Kasutatakse nime/väärtuse paare, mis esindavad andmeid.
- Objekte hoitakse lokkis sulgudes ja iga nime ees on ':' (koolon), väärtuspaarid eraldatakse tähega "," (koma).
- Väärtused eraldatakse tähega "," (koma) ja massiive hoitakse nurksulgudes.
JSON toetab kahte järgmist andmestruktuuri:
- Järjestatud väärtuste loend: See võib olla massiiv, loend või vektor.
- Nime/väärtuste paaride kogu: Seda andmestruktuuri toetavad erinevad arvutikeeled.
JSON (objekt)
JSON-skeem on JSON-objekt, mis kirjeldab erineva JSON-objekti tüüpi ja struktuuri. JavaScripti objekti avaldis võib esindada JSON-objekti JavaScripti käituskeskkondades. Mõned näited kehtivatest skeemiobjektidest on järgmised.
| Skeem | Tikud |
| {} | mis tahes väärtust |
| {tüüp: 'objekt' } | JavaScripti objekt |
| { type: 'number' } | JavaScripti number |
| {tüüp: 'string'} | JavaScripti string |
Nt:
Uue tühja objekti loomine:
var JSON_Obj = {};
Uue objekti loomine:
var JSON_Obj = uus objekt()
JSON (võrdlus XML-iga)
JSON ja XML on keelest sõltumatud inimloetavad vormingud. Reaalse maailma stsenaariumide korral saavad nad nii luua, lugeda kui ka dekodeerida. Järgmiste kriteeriumide alusel võime võrrelda JSON-i XML-iga.
Keerukus
Kuna XML on keerulisem kui JSON, eelistavad programmeerijad JSON-i.
Massiivide kasutamine
XML-i kasutatakse struktureeritud andmete väljendamiseks; XML aga massiive ei toeta, küll aga JSON.
Parsimine
JSON-i tõlgendatakse JavaScripti eval funktsiooni abil. eval tagastab kirjeldatud objekti, kui seda kasutatakse koos JSON-iga.
Näide:
| JSON | XML |
| {
"ettevõte": Ferrari, "nimi": "GTS", "hind": 404000 } |
Ferrari GTS 404000 XNUMX |
JSON-skeemi eelised
JSON on loodud inimesele ja masinloetavas keeles kõrvale kalduma. Kuid ilma peenhäälestuseta ei saa see olla kumbki. JSON-skeemi eeliseks on see, et JSON on nii masinate kui ka inimeste jaoks arusaadavam.
JSON-skeemi kasutamine eemaldab ka vajaduse mitmete kliendipoolsete värskenduste järele. Levinud HTML-koodide loendi koostamine ja seejärel nende juurutamine kliendi poolel on tüüpiline, kuid ebatäpne meetod kliendipoolseks konstrueerimiseks API rakendusi. See pole aga parim strateegia, sest serveripoolsed muudatused võivad põhjustada teatud funktsioonide talitlushäireid.
JSON-skeemi peamine eelis on selle ühilduvus erinevate programmeerimiskeeltega, samuti valideerimise täpsus ja järjepidevus.
JSON-skeem toetab laia valikut brausereid ja operatsioonisüsteemid, seetõttu ei pea JSON-vormingus kirjutatud rakendused palju vaeva nägema, et muuta need kõik brauseriga ühilduvaks. Arendamise käigus kaaluvad arendajad mitut brauserit, kuigi JSON-il on need võimalused juba olemas.
JSON on kõige tõhusam viis mis tahes suurusega andmete (sh heli, video ja muu meedia) jagamiseks. Selle põhjuseks on asjaolu, et JSON salvestab andmed massiividesse, mis muudab andmeedastuse lihtsamaks. Selle tulemusel on JSON parim failivorming veebipõhiste API-de ja arenduse jaoks.
Kuna API-d muutuvad levinumaks, on loogiline eeldada, et API valideerimine ja testimine muutuvad üha olulisemaks. Samuti on realistlik eeldada, et JSON ei muutu aja jooksul tõenäoliselt palju lihtsamaks. See tähendab, et teie andmete skeemi olemasolu muutub aja möödudes kriitilisemaks. Kuna JSON on API-dega töötamise standardne failivorming, on JSON-skeem API-dega töötavate jaoks hea asendus.