Ghid pentru schema JSON
Înainte de a intra în schema JSON, este important să cunoaștem diferența dintre schema JSON și schema JSON.
JSON
JSON este prescurtarea pentru JavaScript Object Notation și este un format de date independent de limbă pe care API-urile îl folosesc pentru a trimite cereri și răspunsuri. JSON este ușor de citit și de scris atât pentru oameni, cât și pentru mașini. JSON este un format bazat pe text care nu este legat de limbă (independent de limbă).
Schema JSON
Schema JSON este un instrument util pentru verificarea structurii datelor JSON. Pentru a specifica structura JSON, utilizați un format bazat pe JSON. Scopul său este de a se asigura că datele JSON sunt acceptabile. Convenția pentru datele JSON ale aplicației noastre poate fi definită folosind schema.
Există trei secțiuni principale ale specificației Schemei JSON:
Hyper-Schema JSON:
JSON Hyper-Schema este un limbaj JSON Schema care poate fi folosit pentru a eticheta documentele JSON cu hyperlinkuri și instrucțiuni pentru procesarea și modificarea resurselor JSON externe prin medii bazate pe text, cum ar fi HTTP. Clic aici pentru a afla mai multe despre JSON Hyper-Schema.
Nucleul schemei JSON:
Este un set de reguli pentru etichetarea și validarea documentelor JSON.
Nucleul schemei JSON:
- Descrie formatul de date pe care îl aveți în prezent.
- Validează datele care pot fi utilizate în testarea automată.
- Asigurarea acurateții datelor furnizate de clienți.
- Oferă documentație lizibilă atât pentru oameni, cât și pentru mașini.
Validarea schemei JSON:
Validarea bazată pe schema JSON impune limite asupra structurii datelor instanței. După aceea, orice cuvinte cheie care nu au afirmare informații, cum ar fi metadatele descriptive și indicațiile de utilizare, sunt adăugate la o poziție de instanță care îndeplinește toate constrângerile declarate.
Instrumentul JSON Schema Validator de la Newtonsoft este un instrument pe care îl puteți utiliza direct în browser, gratuit. Puteți utiliza acest instrument pentru a testa structura schemei dvs. JSON. Această pagină conține comenzi și explicații pentru a începe. În acest fel, este ușor să vedeți cum să vă îmbunătățiți structura JSON.
Putem verifica obiectul nostru JSON folosind Instrumentul de validare a schemei JSON:
Avem validarea vârstei (minim = 20 și maxim = 40) așa cum se arată în figura de mai sus. Nu au fost găsite erori.
A afișat o eroare dacă validarea vârstei a fost introdusă incorect.
Crearea unei scheme JSON
Să ne uităm la un exemplu de schemă JSON pentru a vedea despre ce vorbim. Un obiect JSON de bază care descrie un catalog de produse este următorul:
Schema sa JSON ar putea fi scrisă după cum urmează:
O schemă JSON este un document JSON și acel document TREBUIE să fie un obiect. Cuvintele cheie sunt membri/atribute ale obiectelor specificate de schema JSON. „Cuvintele cheie” din schema JSON se referă la partea „cheie” a unei combinații cheie/valoare dintr-un obiect. Scrierea unei scheme JSON implică maparea unui anumit „cuvânt cheie” la o valoare dintr-un obiect în cea mai mare parte.
Să aruncăm o privire mai atentă la cuvintele cheie pe care le-am folosit în exemplul nostru:
Schema JSON la care se conformează schema resursei este scrisă de acest atribut. Această schemă este scrisă urmând standardul drafts v4, așa cum este specificat de „$ schema” cuvânt cheie. Acest lucru împiedică schema dvs. să revină la versiunea curentă, care poate fi sau nu compatibilă cu cea mai veche.
"titlu"Și"descriere” cuvintele cheie sunt doar explicative; nu impun nicio limitare asupra datelor verificate. Aceste două cuvinte cheie descriu scopul schemei: descrie un produs.
"tipcuvântul cheie definește prima condiție de limită a datelor noastre JSON; trebuie să fie un obiect JSON. Dacă nu setăm tipul pentru toate schemele, codul nu ar funcționa. Unele tipuri comune sunt „număr”, „boolean”, „întreg”, „null”, „obiect”, „matrice”, „șir”.
Schema JSON este acceptată de următoarele biblioteci:
Limbă | Bibliotecă |
C | WJElement |
Piton | jschon |
PHP | Descriere Json Schema |
JavaScript | ajv |
Go | gojsonsschema |
Kotlin | Medieia-validator |
Rubin | JSONSchemer |
JSON (sintaxă)
Să aruncăm o scurtă privire la sintaxa fundamentală a JSON. Sintaxa JSON este un subset de sintaxa JavaScript care include următoarele elemente:
- Sunt folosite perechi nume/valoare care reprezintă date.
- Obiectele sunt ținute între acolade și fiecare nume este condus de un „:” (virgulă), cu perechi de valori separate prin „,” (virgulă).
- Valorile sunt separate prin „,” (virgulă), iar tablourile sunt ținute între paranteze drepte.
Următoarele două structuri de date sunt acceptate de JSON:
- Lista ordonata de valori: Poate fi o matrice, o listă sau un vector.
- Colecție de perechi nume/valoare: Diferite limbaje de computer acceptă această structură de date.
JSON (obiect)
O schemă JSON este un obiect JSON care conturează tipul și structura unui obiect JSON diferit. O expresie de obiect JavaScript poate reprezenta un obiect JSON în mediile de rulare JavaScript. Câteva exemple de obiecte de schemă valide sunt următoarele:
Schemă | Meciuri |
{} | orice valoare |
{ tip: „obiect” } | un obiect JavaScript |
{ tip: „număr”} | un număr JavaScript |
{ tip: „șir”} | un șir JavaScript |
De exemplu:
Realizarea unui nou obiect care este gol:
var JSON_Obj = {};
Crearea unui nou obiect:
var JSON_Obj = obiect nou ()
JSON (comparație cu XML)
JSON și XML sunt formate care pot fi citite de om, independente de limbă. În scenariile din lumea reală, ei pot crea, citi și decoda. Pe baza următoarelor criterii, putem compara JSON cu XML.
Complexitate
Deoarece XML este mai complex decât JSON, programatorii preferă JSON.
Utilizarea matricelor
XML este folosit pentru a exprima date structurate; cu toate acestea, XML nu acceptă matrice, dar JSON acceptă.
Analizare
JSON este interpretat folosind funcția de evaluare a JavaScript. eval returnează obiectul descris atunci când este utilizat cu JSON.
Exemplu:
JSON | XML |
{ „companie”: Ferrari, „nume”: „GTS”, „preț”: 404000 } |
Ferrari
GTS
404000
|
Avantajele schemei JSON
JSON este conceput pentru a devia într-un limbaj care poate fi citit de oameni și de mașini. Cu toate acestea, fără anumite reglaje, nu poate fi nici una. Schema JSON are avantajul de a face JSON mai ușor de înțeles atât pentru mașini, cât și pentru oameni.
Utilizarea schemei JSON elimină, de asemenea, necesitatea mai multor actualizări la nivelul clientului. Realizarea unei liste de coduri HTML obișnuite și apoi implementarea lor pe partea clientului este o metodă tipică, dar inexactă de a construi partea clientului API aplicații. Cu toate acestea, aceasta nu este cea mai bună strategie, deoarece modificările de pe partea serverului pot cauza funcționarea defectuoasă a anumitor funcționalități.
Principalul avantaj al Schemei JSON este compatibilitatea cu o varietate de limbaje de programare, precum și acuratețea și consistența validării.
Schema JSON acceptă o gamă largă de browsere și sisteme de operare, prin urmare, aplicațiile scrise în JSON nu necesită mult efort pentru a le face pe toate compatibile cu browserul. În timpul dezvoltării, dezvoltatorii iau în considerare mai multe browsere, deși JSON are deja capabilitățile.
JSON este cel mai eficient mod de a partaja date de orice dimensiune, inclusiv audio, video și alte media. Acest lucru se datorează faptului că JSON stochează datele în matrice, ceea ce facilitează transmiterea datelor. Ca rezultat, JSON este cel mai bun format de fișier pentru API-uri și dezvoltare online.
Pe măsură ce API-urile devin tot mai comune, este logic să presupunem că validarea și testarea API-urilor vor deveni din ce în ce mai importante. De asemenea, este realist să ne așteptăm ca JSON să nu devină mult mai simplu pe măsură ce timpul trece. Acest lucru implică faptul că a avea o schemă pentru datele dvs. va deveni mai important pe măsură ce timpul trece. Deoarece JSON este formatul de fișier standard pentru lucrul cu API-uri, schema JSON este un bun înlocuitor pentru cei care lucrează cu API-uri.
