Кіраўніцтва па схеме JSON
Перш чым мы пяройдзем да схемы JSON, важна ведаць розніцу паміж JSON і схемай JSON.
JSON
JSON - гэта скарачэнне ад JavaScript Object Notation, і гэта незалежны ад мовы фармат даных, які API выкарыстоўвае для адпраўкі запытаў і адказаў. JSON просты для чытання і запісу як для людзей, так і для машын. JSON - гэта тэкставы фармат, які не звязаны з мовай (незалежны ад мовы).
Схема JSON
Схема JSON - карысны інструмент для праверкі структуры даных JSON. Каб вызначыць структуру JSON, выкарыстоўвайце фармат на аснове JSON. Яго мэта - пераканацца, што даныя JSON прымальныя. Канвенцыя для даных JSON нашага прыкладання можа быць вызначана з дапамогай схемы.
У спецыфікацыі схемы JSON ёсць тры асноўныя раздзелы:
Гіперсхема JSON:
JSON Hyper-Schema - гэта мова схемы JSON, якая можа выкарыстоўвацца для пазначэння дакументаў JSON гіперспасылкамі і інструкцыямі па апрацоўцы і змене знешніх рэсурсаў JSON праз тэкставыя асяроддзя, такія як HTTP. Націсніце тут каб даведацца больш аб JSON Hyper-Schema.
Ядро схемы JSON:
Гэта набор правіл пазначэння і праверкі дакументаў JSON.
Ядро схемы JSON:
- Апісвае фармат дадзеных, які ў вас ёсць.
- Правярае дадзеныя, якія можна выкарыстоўваць у аўтаматызаваным тэсціраванні.
- Забеспячэнне дакладнасці даных кліентаў.
- Забяспечвае чытэльную дакументацыю як для людзей, так і для машын.
Праверка схемы JSON:
Праверка на аснове схемы JSON накладае абмежаванні на структуру даных асобніка. Пасля гэтага любыя ключавыя словы, якія не маюць зацвярджэння інфармацыя, такія як апісальныя метададзеныя і паказанні выкарыстання, дадаюцца ў пазіцыю асобніка, якая адпавядае ўсім заяўленым абмежаванням.
Інструмент JSON Schema Validator ад Newtonsoft - гэта інструмент, які можна выкарыстоўваць непасрэдна ў вашым браўзеры, бясплатна. Вы можаце выкарыстоўваць гэты інструмент, каб праверыць структуру вашай схемы JSON. Гэтая старонка змяшчае элементы кіравання і тлумачэнні, якія дапамогуць вам пачаць. Такім чынам, лёгка зразумець, як палепшыць структуру JSON.
Мы можам праверыць наш аб'ект JSON з дапамогай інструмента праверкі схемы JSON:
У нас ёсць праверка ўзросту (мінімум = 20 і максімум = 40), як паказана на малюнку вышэй. Памылак не знойдзена.
Ён адлюстроўваў памылку, калі праверка ўзросту была ўведзена няправільна.
Стварэнне схемы JSON
Давайце паглядзім на прыклад схемы JSON, каб зразумець, пра што мы гаворым. Базавы аб'ект JSON, які апісвае каталог прадуктаў, выглядае наступным чынам:
Яго схема JSON можа быць запісана наступным чынам:
Схема JSON - гэта дакумент JSON, і гэты дакумент ПАВІНЕН быць аб'ектам. Ключавыя словы - гэта члены/атрыбуты аб'екта, вызначаныя схемай JSON. «Ключавыя словы» ў схеме JSON адносяцца да «ключавой» часткі камбінацыі ключ/значэнне ў аб'екце. Напісанне схемы JSON па большай частцы прадугледжвае супастаўленне пэўнага «ключавога слова» са значэннем у аб'екце.
Давайце больш падрабязна разгледзім ключавыя словы, якія мы выкарыстоўвалі ў нашым прыкладзе:
Схема JSON, якой адпавядае схема рэсурсу, запісваецца гэтым атрыбутам. Гэтая схема напісана ў адпаведнасці са стандартам чарнавікоў v4, як вызначана ў «$ схема” ключавое слова. Гэта прадухіляе вяртанне вашай схемы да бягучай версіі, якая можа быць або не сумяшчальная са старой версіяй.
"назва"І"апісанне” ключавыя словы толькі тлумачальныя; яны не накладваюць ніякіх абмежаванняў на дадзеныя, якія правяраюцца. Гэтыя два ключавыя словы апісваюць прызначэнне схемы: яна апісвае прадукт.
"тып” ключавое слова вызначае першую гранічную ўмову нашых дадзеных JSON; гэта павінен быць аб'ект JSON. Калі мы не ўсталюем тып для ўсіх схем, код не будзе працаваць. Некаторыя распаўсюджаныя тыпы: «лік», «Лагічны», «цэлы», «нулявы», «аб'ект», «масіў», «радок».
Схема JSON падтрымліваецца наступнымі бібліятэкамі:
мова | Бібліятэка |
C | WJEэлемент |
Пітон | jschon |
PHP | Апісанне схемы Json |
JavaScript | прым |
Go | гойсонсхема |
Kotlin | Медэя-валідатар |
лал | JSONSchemer |
JSON (Сінтаксіс)
Давайце коратка разгледзім асноўны сінтаксіс JSON. Сінтаксіс JSON - гэта падмноства сінтаксісу JavaScript, якое ўключае наступныя элементы:
- Выкарыстоўваюцца пары імя/значэнне, якія прадстаўляюць даныя.
- Аб'екты ўтрымліваюцца ў фігурных дужках, і кожнае імя пачынаецца з ":" (двукроп'е), з парамі значэнняў, падзеленымі "," (коскай).
- Значэнні падзяляюцца знакамі «,» (коска), а масівы заключаюцца ў квадратныя дужкі.
Дзве наступныя структуры даных падтрымліваюцца JSON:
- Упарадкаваны спіс значэнняў: Гэта можа быць масіў, спіс або вектар.
- Калекцыя пар імя/значэнне: Розныя кампутарныя мовы падтрымліваюць гэтую структуру даных.
JSON (аб'ект)
Схема JSON - гэта аб'ект JSON, які вызначае тып і структуру іншага аб'екта JSON. Выраз аб'екта JavaScript можа прадстаўляць аб'ект JSON у асяроддзі выканання JavaScript. Некаторыя прыклады сапраўдных аб'ектаў схемы наступныя:
Схема | Запалкі |
{} | любое значэнне |
{тып: 'аб'ект'} | аб'ект JavaScript |
{тып: 'нумар'} | нумар JavaScript |
{ тып: 'радок'} | радок JavaScript |
Напрыклад:
Стварэнне новага пустога аб'екта:
var JSON_Obj = {};
Стварэнне новага аб'екта:
var JSON_Obj = новы аб'ект()
JSON (Параўнанне з XML)
JSON і XML з'яўляюцца незалежнымі ад мовы фарматамі, якія чытаюцца чалавекам. У рэальных сцэнарыях яны могуць ствараць, чытаць і дэкадаваць. На падставе наступных крытэраў мы можам параўнаць JSON з XML.
складанасць
Паколькі XML больш складаны, чым JSON, праграмісты аддаюць перавагу JSON.
Выкарыстанне масіваў
XML выкарыстоўваецца для выражэння структураваных даных; аднак XML не падтрымлівае масівы, але JSON падтрымлівае.
Parsing
JSON інтэрпрэтуецца з дапамогай функцыі eval JavaScript. eval вяртае апісаны аб'ект пры выкарыстанні з JSON.
прыклад:
JSON | XML |
{ «Кампанія»: Ferrari, «імя»: «GTS», «Кошт»: 404000 } |
Ферары
ГТС
404000
|
Перавагі схемы JSON
JSON прызначаны для адхілення ў мове, якая чытаецца чалавекам і машынай. Аднак без некаторай тонкай налады не можа быць ні таго, ні іншага. Схема JSON мае перавагу ў тым, што робіць JSON больш зразумелым як для машын, так і для людзей.
Выкарыстанне схемы JSON таксама пазбаўляе ад неабходнасці ў некалькіх абнаўленнях на баку кліента. Стварэнне спісу агульных HTML-кодаў і наступная іх рэалізацыя на баку кліента - тыповы, але недакладны метад стварэння кліенцкага боку API прыкладанні. Аднак гэта не лепшая стратэгія, таму што змены на баку сервера могуць прывесці да збою ў працы некаторых функцый.
Галоўнай перавагай схемы JSON з'яўляецца яе сумяшчальнасць з рознымі мовамі праграмавання, а таксама дакладнасць і паслядоўнасць праверкі.
Схема JSON падтрымлівае шырокі спектр браўзераў і operating systems, таму прыкладанні, напісаныя ў JSON, не патрабуюць шмат намаганняў, каб зрабіць іх усе сумяшчальнымі з браўзерамі. Падчас распрацоўкі распрацоўшчыкі разглядаюць некалькі браўзераў, хаця JSON ужо мае магчымасці.
JSON - гэта найбольш эфектыўны спосаб абмену дадзенымі любога памеру, уключаючы аўдыя, відэа і іншыя носьбіты. Гэта звязана з тым, што JSON захоўвае дадзеныя ў масівах, што палягчае перадачу дадзеных. У выніку JSON з'яўляецца найлепшым фарматам файлаў для анлайнавых API і распрацоўкі.
Паколькі API становяцца ўсё больш распаўсюджанымі, лагічна выказаць здагадку, што праверка і тэставанне API будуць станавіцца ўсё больш важнымі. Таксама рэальна чакаць, што JSON з цягам часу наўрад ці стане нашмат прасцейшым. Гэта азначае, што наяўнасць схемы для вашых даных будзе станавіцца ўсё больш важным з цягам часу. Паколькі JSON з'яўляецца стандартным фарматам файла для працы з API, схема JSON з'яўляецца добрай заменай для тых, хто працуе з API.
