Guía do esquema JSON
Antes de entrar no esquema JSON, é importante coñecer a diferenza entre o esquema JSON e o esquema JSON.
JSON
JSON é a abreviatura de JavaScript Object Notation e é un formato de datos independente da linguaxe que as API usan para enviar solicitudes e respostas. JSON é sinxelo de ler e escribir para persoas e máquinas. JSON é un formato baseado en texto que non está ligado ao idioma (independiente da lingua).
Esquema JSON
O esquema JSON é unha ferramenta útil para verificar a estrutura de datos JSON. Para especificar a estrutura de JSON, use un formato baseado en JSON. O seu propósito é garantir que os datos JSON sexan aceptables. A convención para os datos JSON da nosa aplicación pódese definir mediante un esquema.
Hai tres seccións principais para a especificación do esquema JSON:
Hiperesquema JSON:
JSON Hyper-Schema é unha linguaxe de esquema JSON que se pode usar para etiquetar documentos JSON con hipervínculos e instrucións para procesar e cambiar recursos JSON externos a través de contornos baseados en texto como HTTP. Fai clic aquí para obter máis información sobre JSON Hyper-Schema.
Núcleo de esquema JSON:
É un conxunto de regras para etiquetar e validar documentos JSON.
Núcleo de esquema JSON:
- Describe o formato de datos que tes actualmente.
- Valida os datos que se poden usar en probas automatizadas.
- Asegurar a exactitude dos datos proporcionados polos clientes.
- Ofrece documentación lexible tanto para humanos como para máquinas.
Validación do esquema JSON:
A validación baseada no esquema JSON impón límites á estrutura dos datos da instancia. Despois diso, calquera palabra clave que non teña afirmación información, como metadatos descritivos e indicacións de uso, engádense a unha posición de instancia que cumpre todas as restricións declaradas.
A ferramenta de validación de esquemas JSON de Newtonsoft é unha ferramenta que podes usar directamente no teu navegador, de forma gratuíta. Podes usar esta ferramenta para probar a estrutura do teu esquema JSON. Esta páxina contén controis e explicacións para comezar. Deste xeito, é fácil ver como mellorar a súa estrutura JSON.
Podemos comprobar o noso obxecto JSON usando a ferramenta de validación de esquemas JSON:
Temos validación de idade (mínimo = 20 e máximo = 40) como se mostra na figura anterior. Non se atoparon erros.
Mostraba un erro se a validación da idade se introducía incorrectamente.
A creación dun esquema JSON
Vexamos un exemplo de esquema JSON para ver de que estamos a falar. Un obxecto JSON básico que describe un catálogo de produtos é o seguinte:
O seu esquema JSON pode escribirse do seguinte xeito:
Un esquema JSON é un documento JSON, e ese documento DEBE ser un obxecto. As palabras clave son membros/atributos de obxecto especificados polo esquema JSON. "Palabras clave" no esquema JSON refírense á parte "clave" dunha combinación clave/valor nun obxecto. Escribir un esquema JSON implica na súa maioría mapear unha "palabra clave" particular cun valor dentro dun obxecto.
Vexamos máis de cerca as palabras clave que usamos no noso exemplo:
Este atributo escribe o esquema JSON ao que cumpre o esquema do recurso. Este esquema está escrito seguindo o estándar de borradores v4, tal e como especifica o "$ esquema” palabra clave. Isto evita que o teu esquema volva á versión actual, que pode ser ou non compatible coa versión anterior.
O "título"E"Description” as palabras clave son só explicativas; non impoñen ningunha limitación aos datos que se están a comprobar. Estas dúas palabras clave describen o propósito do esquema: describe un produto.
O "tipo” a palabra clave define a primeira condición de límite dos nosos datos JSON; debe ser un obxecto JSON. Se non establecemos o tipo para todos os esquemas, o código non funcionaría. Algúns tipos comúns son "número", "booleano", "entero", "nulo", "obxecto", "matriz", "cadea".
O esquema JSON é compatible coas seguintes bibliotecas:
Lingua | Biblioteca |
C | Elemento WJE |
Pitão | jschon |
PHP | Ver Esquema Json |
JavaScript | ajv |
Go | gojsonschema |
Kotlin | Medieia-validador |
Rubio | JSONSchemer |
JSON (sintaxe)
Vexamos brevemente a sintaxe fundamental de JSON. A sintaxe JSON é un subconxunto de sintaxe JavaScript que inclúe os seguintes elementos:
- Utilízanse pares nome/valor que representan datos.
- Os obxectos mantéñense entre chaves e cada nome vai dirixido por un ':' (de dous puntos), con pares de valores separados por “,” (coma).
- Os valores están separados por "," (coma) e as matrices mantéñense entre corchetes.
JSON admite as dúas seguintes estruturas de datos:
- Lista ordenada de valores: Pode ser unha matriz, unha lista ou un vector.
- Colección de pares nome/valor: Diferentes linguaxes informáticos admiten esta estrutura de datos.
JSON (obxecto)
Un esquema JSON é un obxecto JSON que describe o tipo e a estrutura dun obxecto JSON diferente. Unha expresión de obxecto JavaScript pode representar un obxecto JSON en ambientes de execución de JavaScript. Algúns exemplos de obxectos de esquema válidos son os seguintes:
Esquema | Fósforo |
{} | calquera valor |
{tipo: 'obxecto'} | un obxecto JavaScript |
{tipo: 'número'} | un número de JavaScript |
{tipo: 'cadea'} | unha cadea de JavaScript |
Ex .:
Creando un novo obxecto que estea baleiro:
var JSON_Obj = {};
Creación de novos obxectos:
var JSON_Obj = obxecto novo ()
JSON (Comparación con XML)
JSON e XML son formatos lexibles por humanos independentes da linguaxe. En escenarios do mundo real, ambos poden crear, ler e decodificar. En función dos seguintes criterios, podemos comparar JSON con XML.
Complexidade
Como XML é máis complexo que JSON, os programadores prefiren JSON.
Uso de Arrays
XML úsase para expresar datos estruturados; con todo, XML non admite matrices, pero JSON si.
Análise
JSON interprétase mediante a función eval de JavaScript. eval devolve o obxecto descrito cando se usa con JSON.
Exemplo:
JSON | XML |
{ "empresa": Ferrari, “nome”: “GTS”, "prezo": 404000 } |
Ferrari
GTS
404000
|
Vantaxes do esquema JSON
JSON está deseñado para desviarse nunha linguaxe lexible por persoas e máquinas. Non obstante, sen algúns axustes, non pode ser ningún dos dous. O esquema JSON ten a vantaxe de facer que JSON sexa máis comprensible tanto para máquinas como para humanos.
Usar o esquema JSON tamén elimina a necesidade de varias actualizacións do lado do cliente. Facer unha lista de códigos HTML comúns e despois implementalos no lado do cliente é un método típico pero inexacto para construír o lado do cliente. API aplicacións. Non obstante, esta non é a mellor estratexia porque os cambios no servidor poden provocar un mal funcionamento de determinadas funcionalidades.
A principal vantaxe do esquema JSON é a súa compatibilidade con unha variedade de linguaxes de programación, así como a precisión e consistencia da validación.
O esquema JSON admite unha ampla gama de navegadores e sistemas operativos, polo tanto, as aplicacións escritas en JSON non requiren moito esforzo para que todas sexan compatibles co navegador. Durante o desenvolvemento, os desenvolvedores consideran varios navegadores, aínda que JSON xa ten as capacidades.
JSON é a forma máis eficiente de compartir datos de calquera tamaño, incluídos audio, vídeo e outros medios. Isto débese ao feito de que JSON almacena datos en matrices, o que facilita a transmisión de datos. Como resultado, JSON é o mellor formato de ficheiro para API e desenvolvemento en liña.
A medida que as API son máis comúns, é lóxico asumir que a validación e as probas das API serán cada vez máis importantes. Tamén é realista esperar que non é probable que JSON sexa moito máis sinxelo a medida que pasa o tempo. Isto implica que ter un esquema para os teus datos só vai ser máis crítico a medida que pasa o tempo. Como JSON é o formato de ficheiro estándar para traballar con API, o esquema JSON é un bo substituto para aqueles que traballan con API.
