JSON Schema සඳහා මාර්ගෝපදේශය
අපි JSON Schema වෙත යාමට පෙර, JSON සහ JSON Schema අතර වෙනස දැන ගැනීම වැදගත් වේ.
JSON
JSON යනු JavaScript Object Notation සඳහා කෙටි වන අතර, එය APIs ඉල්ලීම් සහ පිළිතුරු යැවීමට භාවිතා කරන භාෂා-ස්වාධීන දත්ත ආකෘතියකි. JSON මිනිසුන්ට සහ යන්ත්‍ර සඳහා කියවීමට සහ ලිවීමට සරල ය. JSON යනු භාෂාවට බැඳී නැති (භාෂා ස්වාධීන) පෙළ-පාදක ආකෘතියකි.
JSON යෝජනා ක්රමය
JSON Schema යනු JSON දත්ත ව්‍යුහය සත්‍යාපනය කිරීම සඳහා ප්‍රයෝජනවත් මෙවලමකි. JSON හි ව්‍යුහය සඳහන් කිරීමට, JSON-පාදක ආකෘතියක් භාවිතා කරන්න. එහි අරමුණ JSON දත්ත පිළිගත හැකි බව සහතික කිරීමයි. අපගේ යෙදුමේ JSON දත්ත සඳහා වන සම්මුතිය යෝජනා ක්රමය භාවිතයෙන් අර්ථ දැක්විය හැක.
JSON Schema පිරිවිතර සඳහා ප්‍රධාන කොටස් තුනක් ඇත:
JSON Hyper-Skema:
JSON Hyper-Schema යනු JSON Schema භාෂාවක් වන අතර එය JSON ලේඛන අධි සබැඳි සමඟ ලේබල් කිරීමට සහ HTTP වැනි පෙළ පදනම් වූ පරිසරයන් හරහා බාහිර JSON සම්පත් සැකසීමට සහ වෙනස් කිරීමට උපදෙස්. ක්ලික් කරන්න මෙහි JSON Hyper-Schema ගැන වැඩිදුර දැන ගැනීමට.
JSON Schema Core:
එය JSON ලේඛන ලේබල් කිරීම සහ වලංගු කිරීම සඳහා වන නීති මාලාවකි.
JSON Schema Core:
- ඔබ දැනට ඇති දත්ත ආකෘතිය විස්තර කරයි.
- ස්වයංක්‍රීය පරීක්‍ෂණයේදී භාවිත කළ හැකි දත්ත වලංගු කරයි.
- ගනුදෙනුකරුවන් විසින් ලබා දෙන දත්තවල නිරවද්‍යතාවය සහතික කිරීම.
- මිනිසුන්ට සහ යන්ත්‍ර සඳහා කියවිය හැකි ලියකියවිලි සපයයි.
JSON යෝජනා ක්රමය වලංගුකරණය:
JSON Schema මත පදනම් වූ වලංගුකරණය නිදසුන් දත්තවල ව්‍යුහය මත සීමාවන් පනවයි. ඊට පසු, ප්‍රකාශයක් නොමැති ඕනෑම මූල පද තොරතුරු, විස්තරාත්මක පාර-දත්ත සහ භාවිත ඇඟවීම් වැනි, සියලුම ප්‍රකාශිත සීමාවන් සපුරාලන අවස්ථාවට එක් කෙරේ.
Newtonsoft's JSON Schema Validator මෙවලම ඔබට ඔබගේ බ්‍රවුසරයේ නොමිලේ භාවිතා කළ හැකි මෙවලමකි. ඔබගේ JSON යෝජනා ක්‍රමයේ ව්‍යුහය පරීක්ෂා කිරීමට ඔබට මෙම මෙවලම භාවිතා කළ හැක. ඔබ ආරම්භ කිරීම සඳහා මෙම පිටුවෙහි පාලන සහ පැහැදිලි කිරීම් අඩංගු වේ. ඒ ආකාරයෙන්, ඔබේ JSON ව්‍යුහය වැඩිදියුණු කරන්නේ කෙසේදැයි බැලීම පහසුය.
JSON Schema Validation Tool භාවිතයෙන් අපට අපගේ JSON වස්තුව පරීක්ෂා කළ හැක:
ඉහත රූපයේ දැක්වෙන පරිදි අපට වයස් වලංගුකරණය (අවම = 20 සහ උපරිම = 40) ඇත. කිසිදු දෝෂයක් හමු නොවීය.
වයස වලංගු කිරීම වැරදි ලෙස ඇතුළත් කර ඇත්නම් එය දෝෂයක් පෙන්වයි.
JSON යෝජනා ක්‍රමයක් නිර්මාණය කිරීම
අපි කතා කරන්නේ කුමක් දැයි බැලීමට JSON Schema හි උදාහරණයක් බලමු. නිෂ්පාදන නාමාවලියක් විස්තර කරන මූලික JSON වස්තුවක් පහත පරිදි වේ:
එහි JSON යෝජනා ක්රමය පහත පරිදි ලිවිය හැකිය:
JSON Schema යනු JSON ලේඛනයක් වන අතර එම ලේඛනය වස්තුවක් විය යුතුය. මූලපද යනු JSON Schema විසින් නිශ්චිතව දක්වා ඇති වස්තු සාමාජිකයන්/ගුණාංග වේ. JSON Schema හි “මූලපද” යන්නෙන් අදහස් කරන්නේ වස්තුවක ඇති යතුරු/අගය සංයෝජනයක “යතුරු” කොටසයි. JSON යෝජනා ක්‍රමයක් ලිවීමට බොහෝ දුරට වස්තුවක් තුළ ඇති අගයකට විශේෂිත “මූලපදයක්” සිතියම්ගත කිරීම ඇතුළත් වේ.
අපගේ උදාහරණයේ අප භාවිතා කළ මූල පද දෙස සමීපව බලමු:
සම්පතේ යෝජනා ක්රමය අනුකූල වන JSON යෝජනා ක්රමය මෙම ගුණාංගයෙන් ලියා ඇත. මෙම යෝජනා ක්රමය ලියා ඇත්තේ කෙටුම්පත් v4 ප්‍රමිතියට අනුව, "$ යෝජනා ක්රමය” මූල පදය. මෙය ඔබගේ යෝජනා ක්රමය පැරණි ඒවා සමඟ නොගැලපෙන හෝ නොගැලපෙන වත්මන් අනුවාදයට වැටීමෙන් වලක්වයි.
එම "ශීර්ෂය" සහ "විස්තර” මූල පද හුදෙක් පැහැදිලි කිරීමකි; ඔවුන් පරීක්ෂා කරනු ලබන දත්ත වලට කිසිදු සීමාවක් පනවා නැත. මෙම මූල පද දෙක යෝජනා ක්‍රමයේ අරමුණ විස්තර කරයි: එය නිෂ්පාදනයක් විස්තර කරයි.
එම "වර්ගය” මූල පදය අපගේ JSON දත්තවල පළමු මායිම් තත්ත්වය නිර්වචනය කරයි; එය JSON වස්තුවක් විය යුතුය. අපි සියලු යෝජනා ක්‍රම සඳහා වර්ගය සකසා නොමැති නම්, කේතය ක්‍රියා නොකරයි. සමහර පොදු වර්ග "සංඛ්‍යාව" "බූලියන්" "නිඛිල" "ශුන්‍ය" "වස්තුව" "අරාව" "තන්තුව" වේ.
JSON Schema පහත පුස්තකාල මගින් සහාය දක්වයි:
භාෂා | පුස්තකාලය |
C | WJElement |
Python මීට උදාහරණ | jschon |
PHP | Opis Json Schema |
ජාවාස්ක්රිප්ට් | ajv |
Go | gojsonschema |
කොට්ලින් | මාධ්ය වලංගුකාරකය |
රූබි | JSONSchemer |
JSON (Syntax)
අපි JSON හි මූලික වාක්‍ය ඛණ්ඩය දෙස කෙටියෙන් බලමු. JSON සින්ටැක්ස් යනු පහත මූලද්‍රව්‍ය ඇතුළත් ජාවාස්ක්රිප්ට් සින්ටැක්ස් හි උප කුලකයකි:
- දත්ත නියෝජනය කරන නම/අගය යුගල භාවිතා වේ.
- වස්තු රැලි සහිත වරහන් වල රඳවා ඇති අතර, එක් එක් නම මෙහෙයවනු ලබන්නේ ':' (කොලනය), අගය යුගල "" (කොමාව) මගින් වෙන් කර ඇත.
- අගයන් "," (කොමාව) මගින් වෙන් කර ඇති අතර අරා වර්ග වරහන් තුළ රඳවා ඇත.
පහත දත්ත ව්‍යුහ දෙක JSON විසින් සහාය දක්වයි:
- ඇණවුම් කළ අගයන් ලැයිස්තුව: එය අරාවක්, ලැයිස්තුවක් හෝ දෛශිකයක් විය හැකිය.
- නම/අගය යුගල එකතුව: විවිධ පරිගණක භාෂා මෙම දත්ත ව්‍යුහයට සහය දක්වයි.
JSON (වස්තුව)
JSON schema යනු වෙනස් JSON වස්තුවක වර්ගය සහ ව්‍යුහය ගෙනහැර දක්වන JSON වස්තුවකි. JavaScript වස්තු ප්‍රකාශනයකට JavaScript ධාවන කාල පරිසරය තුළ JSON වස්තුවක් නියෝජනය කළ හැක. වලංගු ක්‍රම වස්තු සඳහා උදාහරණ කිහිපයක් පහත පරිදි වේ:
යෝජනා ක්රමය | තරග |
{} | ඕනෑම අගයක් |
{type: 'object'} | JavaScript වස්තුවක් |
{ වර්ගය: 'අංකය'} | JavaScript අංකයක් |
{type: 'string'} | JavaScript තන්තුවක් |
උදා:
හිස් වූ නව වස්තුවක් සෑදීම:
var JSON_Obj = {};
නව වස්තු නිර්මාණය:
var JSON_Obj = නව වස්තුව()
JSON (XML සමඟ සැසඳීම)
JSON සහ XML යනු භාෂාවෙන් ස්වාධීන මිනිසුන්ට කියවිය හැකි ආකෘති වේ. සැබෑ ලෝකයේ අවස්ථා වලදී, ඔවුන්ට නිර්මාණය කිරීමට, කියවීමට සහ විකේතනය කිරීමට හැකිය. පහත නිර්ණායක මත පදනම්ව, අපට JSON XML සමඟ සංසන්දනය කළ හැක.
සංකීර්ණත්වය
XML JSON වලට වඩා සංකීර්ණ නිසා, ක්‍රමලේඛකයින් JSON වලට වැඩි කැමැත්තක් දක්වයි.
Arrays භාවිතය
ව්‍යුහගත දත්ත ප්‍රකාශ කිරීමට XML භාවිතා කරයි; කෙසේ වෙතත්, XML අරා සඳහා සහය නොදක්වයි, නමුත් JSON සහාය දක්වයි.
විග්‍රහ කිරීම
JSON ජාවාස්ක්රිප්ට් හි eval ශ්‍රිතය භාවිතයෙන් අර්ථකථනය කෙරේ. eval JSON සමඟ භාවිතා කරන විට විස්තර කරන ලද වස්තුව ලබා දෙයි.
උදාහරණයක්:
JSON | XML |
{ "සමාගම": ෆෙරාරි, "නම": "GTS", "මිල": 404000 } |
ෆෙරාරි
GTS
404000
|
JSON යෝජනා ක්රමය වාසි
JSON නිර්මාණය කර ඇත්තේ මිනිසාට සහ යන්ත්‍රයෙන් කියවිය හැකි භාෂාවකින් අපගමනය කිරීමට ය. කෙසේ වෙතත්, යම් සියුම් සුසර කිරීමකින් තොරව, එය දෙකම විය නොහැක. JSON යන්ත්‍ර සහ මිනිසුන් යන දෙඅංශයෙන්ම JSON වඩාත් තේරුම් ගත හැකි කිරීමේ වාසිය JSON Schema සතු වේ.
JSON Schema භාවිතා කිරීමෙන් සේවාලාභී පාර්ශ්ව යාවත්කාලීන කිහිපයක් සඳහා අවශ්‍යතාවය ද ඉවත් කරයි. පොදු HTML කේත ලැයිස්තුවක් සාදා ඒවා සේවාලාභියාගේ පැත්තෙන් ක්‍රියාත්මක කිරීම සාමාන්‍ය නමුත් සාවද්‍ය ක්‍රමයකි. API යෙදුම්. කෙසේ වෙතත්, මෙය හොඳම උපාය මාර්ගය නොවේ, මන්ද සේවාදායක පැත්තේ වෙනස්කම් සමහර ක්‍රියාකාරීත්වයන් අක්‍රිය වීමට හේතු විය හැක.
JSON Schema හි ප්‍රධාන වාසිය වන්නේ විවිධ ක්‍රමලේඛන භාෂා සමඟ එහි ගැළපුම මෙන්ම වලංගුකරණයේ නිරවද්‍යතාවය සහ අනුකූලතාවයයි.
JSON schema පුළුල් පරාසයක බ්‍රව්සර් සඳහා සහය දක්වයි මෙහෙයුම් පද්ධති, එබැවින් JSON හි ලියා ඇති යෙදුම් ඒවා සියල්ලම බ්‍රවුසරයට අනුකූල කිරීමට වැඩි උත්සාහයක් නොගනී. සංවර්ධනය අතරතුර, සංවර්ධකයින් බ්‍රව්සර් කිහිපයක් සලකා බලයි, නමුත් JSON සතුව දැනටමත් හැකියාවන් ඇත.
JSON යනු ශ්‍රව්‍ය, දෘශ්‍ය සහ වෙනත් මාධ්ය ඇතුළුව ඕනෑම ප්‍රමාණයක දත්ත බෙදා ගැනීමට වඩාත් කාර්යක්ෂම ක්‍රමයයි. මෙයට හේතුව JSON විසින් දත්ත සම්ප්‍රේෂණය පහසු කරන array වල දත්ත ගබඩා කිරීමයි. එහි ප්‍රතිඵලයක් වශයෙන්, සබැඳි API සහ සංවර්ධනය සඳහා හොඳම ගොනු ආකෘතිය JSON වේ.
API වඩාත් සුලභ ලෙස වර්ධනය වන විට, API වලංගුකරණය සහ පරීක්ෂාව වඩ වඩාත් වැදගත් වනු ඇතැයි උපකල්පනය කිරීම තාර්කික ය. කාලය ගෙවී යන විට JSON වඩා සරල නොවනු ඇතැයි අපේක්ෂා කිරීම යථාර්ථවාදී ය. මෙයින් ඇඟවෙන්නේ ඔබේ දත්ත සඳහා යෝජනා ක්‍රමයක් තිබීම කාලයත් සමඟ වඩාත් තීරණාත්මක වන බවයි. JSON API සමඟ වැඩ කිරීම සඳහා සම්මත ගොනු ආකෘතිය නිසා, JSON Schema API සමඟ වැඩ කරන අය සඳහා හොඳ ආදේශකයකි.
