Průvodce schématem JSON
Než se pustíme do schématu JSON, je důležité znát rozdíl mezi schématem JSON a JSON.
JSON
JSON je zkratka pro JavaScript Object Notation a je to datový formát nezávislý na jazyce, který rozhraní API používají k odesílání požadavků a odpovědí. JSON se snadno čte a píše pro lidi i stroje. JSON je textový formát, který není vázán na jazyk (jazykově nezávislý).
Schéma JSON
JSON Schema je užitečný nástroj pro ověřování datové struktury JSON. Chcete-li určit strukturu JSON, použijte formát založený na JSON. Jeho účelem je zajistit, aby data JSON byla přijatelná. Konvenci pro data JSON naší aplikace lze definovat pomocí schématu.
Specifikace schématu JSON má tři hlavní části:
Hyper-Schema JSON:
JSON Hyper-Schema je jazyk schématu JSON, který lze použít k označení dokumentů JSON hypertextovými odkazy a pokyny pro zpracování a změnu externích zdrojů JSON prostřednictvím textových prostředí, jako je HTTP. Klikněte zde se dozvíte více o JSON Hyper-Schema.
Jádro schématu JSON:
Jedná se o soubor pravidel pro označování a ověřování dokumentů JSON.
Jádro schématu JSON:
- Popisuje formát dat, který aktuálně máte.
- Ověřuje data, která lze použít při automatizovaném testování.
- Zajištění správnosti dat poskytovaných klienty.
- Poskytuje čitelnou dokumentaci pro lidi i stroje.
Ověření schématu JSON:
Ověření založené na schématu JSON omezuje strukturu dat instance. Poté všechna klíčová slova, která nemají tvrzení informace, jako jsou popisná metadata a indikace použití, jsou přidány do pozice instance, která splňuje všechna deklarovaná omezení.
Nástroj JSON Schema Validator společnosti Newtonsoft je nástroj, který můžete zdarma používat přímo ve svém prohlížeči. Tento nástroj můžete použít k testování struktury schématu JSON. Tato stránka obsahuje ovládací prvky a vysvětlení, která vám pomohou začít. Tímto způsobem je snadné zjistit, jak zlepšit strukturu JSON.
Náš objekt JSON můžeme zkontrolovat pomocí nástroje JSON Schema Validation Tool:
Máme ověření věku (minimum = 20 a maximum = 40), jak je znázorněno na obrázku výše. Nebyly nalezeny žádné chyby.
Pokud bylo ověření věku zadáno nesprávně, zobrazila se chyba.
Vytvoření schématu JSON
Podívejme se na příklad schématu JSON, abychom viděli, o čem mluvíme. Základní objekt JSON popisující katalog produktů je následující:
Jeho schéma JSON může být napsáno takto:
Schéma JSON je dokument JSON a tento dokument MUSÍ být objekt. Klíčová slova jsou členy/atributy objektu specifikované schématem JSON. „Klíčová slova“ ve schématu JSON odkazují na „klíčovou“ část kombinace klíč/hodnota v objektu. Psaní schématu JSON většinou zahrnuje mapování konkrétního „klíčového slova“ na hodnotu v objektu.
Podívejme se blíže na klíčová slova, která jsme použili v našem příkladu:
Schéma JSON, kterému vyhovuje schéma zdroje, je zapsáno tímto atributem. Toto schéma je napsáno podle standardu drafts v4, jak je uvedeno v dokumentu „$ schéma“. Tím zabráníte tomu, aby se vaše schéma vrátilo k aktuální verzi, která může, ale nemusí být kompatibilní se staršími verzemi.
"titul"A"popis” klíčová slova jsou pouze vysvětlující; nekladou žádná omezení na kontrolovaná data. Tato dvě klíčová slova popisují účel schématu: popisuje produkt.
"typKlíčové slovo ” definuje první okrajovou podmínku našich dat JSON; musí to být objekt JSON. Pokud nenastavíme typ pro všechna schémata, kód by nefungoval. Některé běžné typy jsou „číslo“, „logická hodnota“, „celé číslo“, „null“, „objekt“, „pole“, „řetězec“.
Schéma JSON je podporováno následujícími knihovnami:
Jazyk | Knihovna |
C | WJElement |
PYTHON | jschon |
PHP | Popis schématu Json |
JavaScript | ajv |
Go | gojsonschema |
Kotlin | Medieia-validator |
Rubín | JSONSchemer |
JSON (syntaxe)
Pojďme se krátce podívat na základní syntaxi JSON. Syntaxe JSON je podmnožinou syntaxe JavaScriptu, která obsahuje následující prvky:
- Používají se dvojice název/hodnota, které představují data.
- Objekty jsou drženy ve složených závorkách a každý název je uvozen ':' (dvojtečka), přičemž páry hodnot jsou odděleny „,“ (čárkou).
- Hodnoty jsou odděleny „,“ (čárkou) a pole jsou v hranatých závorkách.
JSON podporuje následující dvě datové struktury:
- Seřazený seznam hodnot: Může to být pole, seznam nebo vektor.
- Sbírka párů jméno/hodnota: Tuto datovou strukturu podporují různé počítačové jazyky.
JSON (objekt)
Schéma JSON je objekt JSON, který nastiňuje typ a strukturu jiného objektu JSON. Výraz objektu JavaScript může představovat objekt JSON v běhových prostředích JavaScriptu. Některé příklady platných objektů schématu jsou následující:
Schéma | Zápasy |
{} | jakoukoli hodnotu |
{ type: 'objekt' } | objekt JavaScriptu |
{ type: 'číslo' } | JavaScriptové číslo |
{ type: 'string'} | řetězec JavaScriptu |
Např:
Vytvoření nového objektu, který je prázdný:
var JSON_Obj = {};
Vytvoření nového objektu:
var JSON_Obj = nový objekt()
JSON (porovnání s XML)
JSON a XML jsou jazykově nezávislé formáty čitelné pro člověka. Ve scénářích reálného světa mohou vytvářet, číst a dekódovat. Na základě následujících kritérií můžeme porovnat JSON s XML.
Komplexita
Protože XML je složitější než JSON, programátoři preferují JSON.
Použití polí
XML se používá k vyjádření strukturovaných dat; XML však nepodporuje pole, ale JSON ano.
Parsování
JSON je interpretován pomocí funkce eval JavaScriptu. eval při použití s JSON vrátí popsaný objekt.
Příklad:
JSON | XML |
{ "společnost": Ferrari, "name": "GTS", "cena": 404000 XNUMX } |
Ferrari
GTS
404000 XNUMX
|
Výhody schématu JSON
JSON je navržen tak, aby se vychyloval v lidsky i strojově čitelném jazyce. Bez určitého doladění však nemůže být ani jedno ani druhé. Schéma JSON má tu výhodu, že je JSON srozumitelnější pro stroje i lidi.
Použití schématu JSON také odstraňuje potřebu několika aktualizací na straně klienta. Vytvoření seznamu běžných HTML kódů a jejich následná implementace na straně klienta je typická, ale nepřesná metoda konstrukce na straně klienta. API aplikace. Toto však není nejlepší strategie, protože změny na straně serveru mohou způsobit selhání určitých funkcí.
Hlavní výhodou schématu JSON je jeho kompatibilita s řadou programovacích jazyků a také přesnost a konzistence ověřování.
Schéma JSON podporuje širokou škálu prohlížečů a operační systémy, proto aplikace napsané v JSON nevyžadují velké úsilí, aby byly všechny kompatibilní s prohlížečem. Během vývoje vývojáři zvažují několik prohlížečů, ačkoli JSON již má schopnosti.
JSON je nejefektivnější způsob sdílení dat jakékoli velikosti, včetně zvuku, videa a dalších médií. To je způsobeno tím, že JSON ukládá data do polí, což usnadňuje přenos dat. Výsledkem je, že JSON je nejlepší formát souboru pro online rozhraní API a vývoj.
Vzhledem k tomu, že rozhraní API jsou stále běžnější, je logické předpokládat, že ověřování a testování API bude stále důležitější. Je také realistické očekávat, že JSON pravděpodobně nebude s postupem času mnohem jednodušší. To znamená, že mít schéma pro vaše data bude s postupem času stále důležitější. Protože JSON je standardní formát souboru pro práci s rozhraními API, schéma JSON je dobrou náhradou za ty, kteří pracují s rozhraními API.
