Guia de l'esquema JSON
Abans d'entrar a l'esquema JSON, és important conèixer la diferència entre l'esquema JSON i l'esquema JSON.
JSON
JSON és l'abreviatura de JavaScript Object Notation i és un format de dades independent de l'idioma que les API utilitzen per enviar sol·licituds i respostes. JSON és fàcil de llegir i escriure per a persones i màquines. JSON és un format basat en text que no està lligat a l'idioma (independent de l'idioma).
Esquema JSON
L'esquema JSON és una eina útil per verificar l'estructura de dades JSON. Per especificar l'estructura de JSON, utilitzeu un format basat en JSON. El seu propòsit és garantir que les dades JSON siguin acceptables. La convenció per a les dades JSON de la nostra aplicació es pot definir mitjançant un esquema.
Hi ha tres seccions principals a l'especificació de l'esquema JSON:
Hiper-esquema JSON:
JSON Hyper-Schema és un llenguatge d'esquema JSON que es pot utilitzar per etiquetar documents JSON amb hiperenllaços i instruccions per processar i canviar recursos JSON externs mitjançant entorns basats en text com HTTP. Feu clic aquí per obtenir més informació sobre JSON Hyper-Schema.
Nucli de l'esquema JSON:
És un conjunt de regles per etiquetar i validar documents JSON.
Nucli de l'esquema JSON:
- Descriu el format de dades que teniu actualment.
- Valida les dades que es poden utilitzar en proves automatitzades.
- Assegurar l'exactitud de les dades facilitades pels clients.
- Proporciona documentació llegible tant per a persones com per a màquines.
Validació de l'esquema JSON:
La validació basada en l'esquema JSON imposa límits a l'estructura de les dades de la instància. Després d'això, qualsevol paraula clau que no tingui afirmació informació, com ara metadades descriptives i indicacions d'ús, s'afegeixen a una posició de la instància que compleix totes les restriccions declarades.
L'eina de validació d'esquemes JSON de Newtonsoft és una eina que podeu utilitzar directament al vostre navegador de manera gratuïta. Podeu utilitzar aquesta eina per provar l'estructura del vostre esquema JSON. Aquesta pàgina conté controls i explicacions per començar. D'aquesta manera, és fàcil veure com millorar la vostra estructura JSON.
Podem comprovar el nostre objecte JSON mitjançant l'eina de validació d'esquemes JSON:
Tenim validació d'edat (mínim = 20 i màxim = 40) tal com es mostra a la figura anterior. No s'han trobat errors.
Mostrava un error si la validació d'edat s'havia introduït incorrectament.
La creació d'un esquema JSON
Vegem un exemple d'esquema JSON per veure de què estem parlant. Un objecte JSON bàsic que descriu un catàleg de productes és el següent:
El seu esquema JSON es podria escriure de la següent manera:
Un esquema JSON és un document JSON i aquest document HA de ser un objecte. Les paraules clau són membres/atributs d'objectes especificats per l'esquema JSON. Les "paraules clau" a l'esquema JSON fan referència a la part "clau" d'una combinació clau/valor en un objecte. Escriure un esquema JSON implica assignar una "paraula clau" particular a un valor dins d'un objecte en la seva major part.
Fem una ullada més de prop a les paraules clau que hem utilitzat al nostre exemple:
L'esquema JSON al qual compleix l'esquema del recurs s'anota mitjançant aquest atribut. Aquest esquema està escrit seguint l'estàndard d'esborranys v4, tal com s'especifica a la "$ esquema” paraula clau. Això evita que el vostre esquema torni a la versió actual, que pot ser o no compatible amb la versió anterior.
La "title"I"descripció” les paraules clau són només explicatives; no imposen cap limitació a les dades que s'estan comprovant. Aquestes dues paraules clau descriuen el propòsit de l'esquema: descriu un producte.
La "type” defineix la primera condició de límit de les nostres dades JSON; ha de ser un objecte JSON. Si no configurem el tipus per a tots els esquemes, el codi no funcionarà. Alguns tipus comuns són "número", "booleà", "número", "nul", "objecte", "matriu", "cadena".
L'esquema JSON és compatible amb les biblioteques següents:
Llenguatge | Library |
C | Element WJE |
Pitó | jschon |
PHP | Descripció Json Schema |
JavaScript | ajv |
Go | gojsonsschema |
Kotlin | Medeia-validador |
Ruby | JSONSchemer |
JSON (sintaxi)
Fem una ullada breu a la sintaxi fonamental de JSON. La sintaxi JSON és un subconjunt de la sintaxi de JavaScript que inclou els elements següents:
- S'utilitzen parells nom/valor que representen dades.
- Els objectes es mantenen entre claus, i cada nom està dirigit per un ':' (de dos punts), amb parells de valors separats per “,” (coma).
- Els valors estan separats per "," (coma) i les matrius es mantenen entre claudàtors.
JSON admet les dues estructures de dades següents:
- Llista ordenada de valors: Pot ser una matriu, una llista o un vector.
- Col·lecció de parells nom/valor: Diferents llenguatges informàtics admeten aquesta estructura de dades.
JSON (objecte)
Un esquema JSON és un objecte JSON que descriu el tipus i l'estructura d'un objecte JSON diferent. Una expressió d'objecte JavaScript pot representar un objecte JSON en entorns d'execució de JavaScript. Alguns exemples d'objectes d'esquema vàlids són els següents:
Esquema | Llumins |
{} | qualsevol valor |
{ tipus: 'objecte'} | un objecte JavaScript |
{ tipus: 'número'} | un número de JavaScript |
{ tipus: 'cadena'} | una cadena de JavaScript |
Per exemple:
Creació d'un objecte nou que estigui buit:
var JSON_Obj = {};
Creació d'objectes nous:
var JSON_Obj = objecte nou ()
JSON (comparació amb XML)
JSON i XML són formats llegibles per humans independents de l'idioma. En escenaris del món real, poden crear, llegir i descodificar. D'acord amb els criteris següents, podem comparar JSON amb XML.
Complexitat
Com que XML és més complex que JSON, els programadors prefereixen JSON.
Ús de Arrays
XML s'utilitza per expressar dades estructurades; tanmateix, XML no admet matrius, però JSON sí.
Anàlisi
JSON s'interpreta mitjançant la funció d'avaluació de JavaScript. eval retorna l'objecte descrit quan s'utilitza amb JSON.
Exemple:
JSON | XML |
{ "empresa": Ferrari, “nom”: “GTS”, "preu": 404000 } |
Ferrari
GTS
404000
|
Avantatges de l'esquema JSON
JSON està dissenyat per desviar-se en un llenguatge llegible per persones i màquines. Tanmateix, sense una mica d'ajustament, no pot ser cap dels dos. L'esquema JSON té l'avantatge de fer que JSON sigui més entenedor tant per a màquines com per a humans.
L'ús de l'esquema JSON també elimina la necessitat de diverses actualitzacions del costat del client. Fer una llista de codis HTML habituals i, a continuació, implementar-los al costat del client és un mètode típic però inexacte per construir el costat del client. API aplicacions. Tanmateix, aquesta no és la millor estratègia perquè els canvis al costat del servidor poden provocar que certes funcionalitats funcionin malament.
El principal avantatge de JSON Schema és la seva compatibilitat amb una varietat de llenguatges de programació, així com la precisió i la coherència de la validació.
L'esquema JSON admet una àmplia gamma de navegadors i sistemes operatius, per tant, les aplicacions escrites en JSON no requereixen gaire esforç perquè totes siguin compatibles amb el navegador. Durant el desenvolupament, els desenvolupadors consideren diversos navegadors, tot i que JSON ja té les capacitats.
JSON és la manera més eficient de compartir dades de qualsevol mida, inclosos àudio, vídeo i altres mitjans. Això es deu al fet que JSON emmagatzema dades en matrius, cosa que facilita la transmissió de dades. Com a resultat, JSON és el millor format de fitxer per a API i desenvolupament en línia.
A mesura que les API es fan més comunes, és lògic suposar que la validació i les proves de l'API seran cada cop més importants. També és realista esperar que JSON no es faci molt més senzill a mesura que passa el temps. Això implica que tenir un esquema per a les vostres dades només serà més important a mesura que passi el temps. Com que JSON és el format de fitxer estàndard per treballar amb API, l'esquema JSON és un bon substitut per a aquells que treballen amb API.
