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 құжаттарын гиперсілтемелермен және HTTP сияқты мәтінге негізделген орталар арқылы сыртқы JSON ресурстарын өңдеу және өзгерту нұсқауларымен белгілеу үшін пайдаланылуы мүмкін JSON схемасы тілі. басыңыз Мұнда JSON Hyper-Schema туралы көбірек білу үшін.
JSON схемасының ядросы:
Бұл JSON құжаттарын таңбалауға және тексеруге арналған ережелер жиынтығы.
JSON схемасының ядросы:
- Ағымдағы деректер пішімін сипаттайды.
- Автоматтандырылған тестілеуде пайдалануға болатын деректерді растайды.
- Клиенттер берген деректердің дұрыстығын қамтамасыз ету.
- Адамдарға да, машиналарға да оқылатын құжаттаманы қамтамасыз етеді.
JSON схемасын тексеру:
JSON схемасына негізделген тексеру даналық деректер құрылымына шектеулер қояды. Осыдан кейін, бекітуі жоқ кез келген кілт сөздер ақпарат, сипаттаушы метадеректер және пайдалану көрсеткіштері сияқты барлық жарияланған шектеулерге сәйкес келетін дананың орнына қосылады.
Newtonsoft компаниясының JSON Schema Validator құралы - браузерде тікелей тегін пайдалануға болатын құрал. Сіз бұл құралды JSON схемасының құрылымын тексеру үшін пайдалана аласыз. Бұл бетте жұмысты бастау үшін басқару элементтері мен түсіндірмелер бар. Осылайша, JSON құрылымын жақсарту жолын көру оңай.
JSON схемасын тексеру құралы арқылы JSON нысанын тексере аламыз:
Бізде жоғарыдағы суретте көрсетілгендей жасты тексеру (минимум = 20 және максимум = 40) бар. Ешқандай қате табылмады.
Ол жасты тексеру қате енгізілсе, қатені көрсетті.
JSON схемасын құру
Біз не туралы айтып жатқанымызды көру үшін JSON схемасының мысалын қарастырайық. Өнім каталогын сипаттайтын негізгі JSON нысаны келесідей:
Оның JSON схемасы келесідей жазылуы мүмкін:
JSON схемасы JSON құжаты болып табылады және бұл құжат нысан болуы керек. Түйінді сөздер JSON схемасы арқылы көрсетілген нысан мүшелері/атрибуттары. JSON схемасындағы «кілт сөздер» нысандағы кілт/мән комбинациясының «кілт» бөлігін білдіреді. JSON схемасын жазу көбінесе белгілі бір «кілт сөзді» нысан ішіндегі мәнге салыстыруды қамтиды.
Мысалда қолданылған кілт сөздерді толығырақ қарастырайық:
Ресурс схемасы сәйкес келетін JSON схемасы осы төлсипат арқылы жазылады. Бұл схема «V4 стандартының жобаларына сәйкес жазылған.$ схемасы” кілт сөзі. Бұл сіздің схемаңыздың ескі нұсқамен үйлесімді болуы немесе сәйкес келмеуі мүмкін ағымдағы нұсқаға қайта түсуіне жол бермейді.
«тақырып« және »сипаттамасы” кілт сөздер тек түсіндірме болып табылады; олар тексерілетін деректерге ешқандай шектеулер қоймайды. Бұл екі кілт сөз схеманың мақсатын сипаттайды: ол өнімді сипаттайды.
«түрі” кілт сөзі JSON деректерінің бірінші шекаралық шартын анықтайды; ол JSON нысаны болуы керек. Егер біз барлық схемалар үшін типті орнатпасақ, код жұмыс істемейді. Кейбір кең таралған түрлері «сан» «логикалық» «бүтін» «нөл» «объект» «массив» «жол».
JSON схемасына келесі кітапханалар қолдау көрсетеді:
Тіл | Кітапхана |
C | WJElement |
Python | jschon |
PHP | Json схемасы |
JavaScript | ajv |
Go | гожсонсхема |
Котлин | Medeia-валидатор |
лағыл | JSONSchemer |
JSON (синтаксис)
JSON негізгі синтаксисін қысқаша қарастырайық. JSON синтаксисі келесі элементтерді қамтитын JavaScript синтаксисінің ішкі жиыны болып табылады:
- Деректерді көрсететін атау/мән жұптары пайдаланылады.
- Нысандар бұйра жақшаларда ұсталады және әрбір атау ':' (қос нүкте) арқылы, мән жұптары “,” (үтір) арқылы бөлінеді.
- Мәндер «,» (үтір) арқылы бөлінеді және массивтер төртбұрышты жақшада сақталады.
Келесі екі деректер құрылымына JSON қолдау көрсетеді:
- Мәндердің реттелген тізімі: Ол массив, тізім немесе вектор болуы мүмкін.
- Атау/мән жұптарының жинағы: Әртүрлі компьютер тілдері бұл деректер құрылымын қолдайды.
JSON (нысан)
JSON схемасы басқа JSON нысанының түрі мен құрылымын сипаттайтын JSON нысаны болып табылады. JavaScript нысан өрнегі JavaScript орындалу орталарында JSON нысанын көрсете алады. Жарамды схема нысандарының кейбір мысалдары төмендегідей:
Схема | матчтар |
{} | кез келген мән |
{түрі: 'объект'} | JavaScript нысаны |
{түрі: 'сан'} | JavaScript нөмірі |
{түрі: 'жол'} | JavaScript жолы |
Мысалы:
Бос жаңа нысанды жасау:
var JSON_Obj = {};
Жаңа нысан жасау:
var JSON_Obj = жаңа нысан()
JSON (XML-мен салыстыру)
JSON және XML - тілден тәуелсіз адам оқи алатын пішім. Нақты әлемдегі сценарийлерде олар жасай алады, оқи алады және кодты шеше алады. Келесі критерийлерге сүйене отырып, біз JSON мен XML салыстыра аламыз.
Күрделілік
XML JSON-ға қарағанда күрделі болғандықтан, бағдарламашылар JSON-ды артық көреді.
Массивтерді қолдану
XML құрылымдық деректерді өрнектеу үшін қолданылады; дегенмен, XML массивтерді қолдамайды, бірақ JSON қолдайды.
Талдау
JSON JavaScript бағалау функциясы арқылы түсіндіріледі. eval JSON бірге пайдаланылған кезде сипатталған нысанды қайтарады.
Мысал:
JSON | XML |
{ «компания»: Ferrari, «атауы»: «GTS», «бағасы»: 404000 } |
Ferrari
GTS
404000
|
JSON схемасының артықшылықтары
JSON адам және машина оқи алатын тілде ауытқуға арналған. Дегенмен, кейбір нақты баптаусыз бұл екінің бірі болуы мүмкін емес. JSON схемасының JSON-ды машиналар мен адамдар үшін түсінікті ету артықшылығы бар.
JSON схемасын пайдалану сонымен қатар бірнеше клиенттік жаңартулардың қажеттілігін жояды. Жалпы HTML кодтарының тізімін жасау, содан кейін оларды клиент жағында енгізу - клиенттік құрылымды құрудың әдеттегі, бірақ дәл емес әдісі. API қолданбалар. Дегенмен, бұл ең жақсы стратегия емес, себебі сервер жағындағы өзгерістер белгілі бір функциялардың дұрыс жұмыс істемеуіне әкелуі мүмкін.
JSON схемасының басты артықшылығы - оның әртүрлі бағдарламалау тілдерімен үйлесімділігі, сондай-ақ тексерудің дәлдігі мен жүйелілігі.
JSON схемасы браузерлердің кең ауқымын қолдайды және операциялық жүйелер, сондықтан JSON тілінде жазылған қолданбалар олардың барлығын браузермен үйлесімді ету үшін көп күш жұмсамайды. Әзірлеу кезінде әзірлеушілер бірнеше браузерлерді қарастырады, дегенмен JSON мүмкіндіктері қазірдің өзінде бар.
JSON - аудио, бейне және басқа медианы қоса, кез келген өлшемдегі деректерді ортақ пайдаланудың ең тиімді жолы. Бұл JSON деректерді массивтерде сақтайтындығына байланысты, бұл деректерді беруді жеңілдетеді. Нәтижесінде, JSON онлайн API және әзірлеу үшін ең жақсы файл пішімі болып табылады.
API интерфейстері кең тараған сайын, API тексеруі мен тестілеуінің маңыздылығы арта түседі деп болжау қисынды. Уақыт өте келе JSON оңайырақ болмайды деп күту де шындық. Бұл деректерге арналған схеманың болуы уақыт өте келе маңыздырақ бола түсетінін білдіреді. JSON API интерфейстерімен жұмыс істеуге арналған стандартты файл пішімі болғандықтан, JSON схемасы API интерфейстерімен жұмыс істейтіндер үшін жақсы алмастырғыш болып табылады.
