Leiðbeiningar um JSON kerfi
Áður en við förum í JSON Schema er mikilvægt að vita muninn á JSON og JSON Schema.
JSON
JSON er stytting á JavaScript Object Notation, og það er tungumálaóháð gagnasnið sem API notar til að senda beiðnir og svör. JSON er einfalt að lesa og skrifa fyrir fólk og vélar. JSON er textabundið snið sem er ekki bundið við tungumál (tungumál óháð).
JSON kerfi
JSON Schema er gagnlegt tól til að sannreyna JSON gagnaskipulag. Til að tilgreina uppbyggingu JSON skaltu nota JSON byggt snið. Tilgangur þess er að tryggja að JSON gögn séu ásættanleg. Samkomulagið fyrir JSON gögn forritsins okkar getur verið skilgreint með skema.
Það eru þrír meginhlutar í JSON Schema forskriftinni:
JSON háskema:
JSON Hyper-Schema er JSON Schema tungumál sem hægt er að nota til að merkja JSON skjöl með stiklum og leiðbeiningum til að vinna og breyta ytri JSON auðlindum í gegnum textabyggð umhverfi eins og HTTP. Smellur hér til að læra meira um JSON Hyper-Schema.
JSON Schema Core:
Það er sett af reglum til að merkja og staðfesta JSON skjöl.
JSON Schema Core:
- Lýsir gagnasniðinu sem þú ert með núna.
- Staðfestir gögn sem hægt er að nota í sjálfvirkum prófunum.
- Að tryggja nákvæmni gagna sem viðskiptavinir gefa upp.
- Veitir læsileg skjöl fyrir bæði menn og vélar.
Staðfesting JSON kerfis:
Staðfesting byggð á JSON Schema setur takmarkanir á uppbyggingu tilviksgagna. Eftir það eru öll leitarorð sem hafa ekki staðhæfingu upplýsingar, eins og lýsandi lýsigögn og notkunarvísbendingar, er bætt við tilviksstöðu sem uppfyllir allar uppgefnar takmarkanir.
Newtonsoft's JSON Schema Validator tól er tól sem þú getur notað beint í vafranum þínum, þér að kostnaðarlausu. Þú getur notað þetta tól til að prófa uppbyggingu JSON kerfisins þíns. Þessi síða inniheldur stýringar og útskýringar til að koma þér af stað. Þannig er auðvelt að sjá hvernig á að bæta JSON uppbyggingu þína.
Við getum athugað JSON hlutinn okkar með því að nota JSON Schema Validation Tool:
Við erum með aldursstaðfestingu (lágmark = 20 og hámark = 40) eins og sýnt er á myndinni hér að ofan. Engar villur fundust.
Það sýndi villu ef aldursstaðfestingin var rangt slegin inn.
Sköpun JSON kerfis
Við skulum skoða dæmi um JSON Schema til að sjá hvað við erum að tala um. Grunn JSON hlutur sem lýsir vörulista er sem hér segir:
JSON kerfi þess gæti verið skrifað sem hér segir:
JSON Schema er JSON skjal og það skjal VERÐUR að vera hlutur. Leitarorð eru hlutar/eiginleikar sem tilgreindir eru af JSON Schema. „Lykilorð“ í JSON Schema vísa til „lykils“ hluta lykla/gilda samsetningar í hlut. Að skrifa JSON skema felur í sér að kortleggja tiltekið „lykilorð“ við gildi innan hlutar að mestu leyti.
Við skulum skoða nánar lykilorðin sem við notuðum í dæminu okkar:
JSON stefið sem skema auðlindarinnar uppfyllir er skrifað niður af þessari eigind. Þetta skema er skrifað í samræmi við drög v4 staðalsins, eins og tilgreint er af „$ skema“ lykilorð. Þetta kemur í veg fyrir að stefið þitt falli aftur í núverandi útgáfu, sem gæti verið eða ekki samhæft við eldri.
The "titill"Og"lýsing” leitarorð eru bara skýringar; þær setja engar takmarkanir á gögnin sem verið er að athuga. Þessi tvö lykilorð lýsa tilgangi stefsins: það lýsir vöru.
The "tegund” leitarorð skilgreinir fyrsta mörkaskilyrði JSON gagna okkar; það verður að vera JSON hlutur. Ef við setjum ekki gerð fyrir öll skema, myndi kóðinn ekki virka. Sumar algengar gerðir eru „tala“ „Boolean“ „heiltala“ „null“ „hlutur“ „fylki“ „strengur“.
JSON Schema er stutt af eftirfarandi bókasöfnum:
Tungumál | Bókasafn |
C | WJElement |
Python | jschon |
PHP | Lýsing Json Schema |
JavaScript | ajv |
Go | gojsonschema |
Kotlín | Media-validator |
Ruby | JSON Schemer |
JSON (setningafræði)
Við skulum kíkja stuttlega á grundvallar setningafræði JSON. JSON setningafræði er undirmengi JavaScript setningafræði sem inniheldur eftirfarandi þætti:
- Notuð eru nafn/gildi pör sem tákna gögn.
- Hlutum er haldið í krulluðum axlaböndum og hverju nafni er leitt af ':' (ristli), með gildispörum aðskilin með "," (kommu).
- Gildi eru aðskilin með „,“ (kommu) og fylki eru geymd innan hornklofa.
Eftirfarandi tvö gagnaskipulag eru studd af JSON:
- Pöntaður gildislisti: Það getur verið fylki, listi eða vektor.
- Safn nafna/gilda para: Mismunandi tölvutungumál styðja þessa gagnauppbyggingu.
JSON (hlutur)
JSON skema er JSON hlutur sem útlistar gerð og uppbyggingu annars JSON hluts. JavaScript hluti tjáning getur táknað JSON hlut í JavaScript keyrsluumhverfi. Nokkur dæmi um gilda skemahluti eru sem hér segir:
Stef | Matches |
{} | hvaða verðmæti sem er |
{tegund: 'hlutur' } | JavaScript hlutur |
{tegund: 'númer' } | JavaScript númer |
{tegund: 'streng'} | JavaScript strengur |
Td:
Að búa til nýjan hlut sem er tómur:
var JSON_Obj = {};
Ný hlutur:
var JSON_Obj = nýr hlutur()
JSON (samanburður við XML)
JSON og XML eru tungumálsóháð snið sem hægt er að lesa af mönnum. Í raunheimum geta þeir bæði búið til, lesið og afkóða. Byggt á eftirfarandi forsendum gætum við borið JSON saman við XML.
Flækjustig
Vegna þess að XML er flóknara en JSON kjósa forritarar JSON.
Notkun fylkja
XML er notað til að tjá skipulögð gögn; þó styður XML ekki fylki, en JSON gerir það.
Þáttun
JSON er túlkað með því að nota JavaScript aðgerðina. eval skilar hlutnum sem lýst er þegar það er notað með JSON.
Dæmi:
JSON | XML |
{ "fyrirtæki": Ferrari, "nafn": "GTS", „verð“: 404000 } |
Ferrari
GTS
404000
|
Kostir JSON Schema
JSON er hannað til að sveigjast á tungumáli sem hægt er að lesa í mönnum og vélum. Hins vegar, án nokkurrar fínstillingar, getur það verið hvorugt. JSON Schema hefur þann kost að gera JSON skiljanlegra fyrir bæði vélar og menn.
Notkun JSON Schema fjarlægir einnig þörfina fyrir nokkrar uppfærslur viðskiptavinarhliðar. Að búa til lista yfir algenga HTML kóða og síðan útfæra þá á viðskiptavinamegin er dæmigerð en ónákvæm aðferð til að smíða viðskiptavinahlið API öpp. Hins vegar er þetta ekki besta stefnan vegna þess að breytingar á netþjóninum gætu valdið því að ákveðin virkni virki ekki.
Helsti kosturinn við JSON Schema er samhæfni þess við margs konar forritunarmál, svo og nákvæmni og samkvæmni löggildingar.
JSON skema styður mikið úrval vafra og stýrikerfi, þess vegna þurfa forrit sem eru skrifuð í JSON ekki mikla fyrirhöfn til að gera þau öll vafrasamhæf. Meðan á þróun stendur, íhuga verktaki nokkra vafra, þó að JSON hafi nú þegar möguleikana.
JSON er skilvirkasta leiðin til að deila gögnum af hvaða stærð sem er, þar á meðal hljóð, myndbönd og aðra miðla. Þetta er vegna þess að JSON geymir gögn í fylki, sem gerir gagnaflutning auðveldari. Fyrir vikið er JSON besta skráarsniðið fyrir API og þróun á netinu.
Eftir því sem API verða algengari er rökrétt að gera ráð fyrir að staðfesting og prófun API verði sífellt mikilvægari. Það er líka raunhæft að búast við því að JSON verði ekki mikið einfaldara þegar fram líða stundir. Þetta gefur til kynna að það að hafa skema fyrir gögnin þín mun aðeins verða mikilvægari eftir því sem á líður. Vegna þess að JSON er staðlað skráarsnið til að vinna með API, er JSON Schema góður staðgengill fyrir þá sem vinna með API.
