A-Complete-Guide-to-API-Develop-

API සහ API සංවර්ධනය කිරීමේදී සලකා බැලිය යුතු දේ මොනවාද?

API (යෙදුම් ක්‍රමලේඛන අතුරුමුහුණත) යනු මෘදුකාංගයක් හෝ යෙදුමක් වඩා හොඳ සේවා සඳහා වෙනත් යෙදුමක, වේදිකාවක හෝ උපාංගයක විශේෂාංග හෝ සේවා භාවිතා කිරීමට හැකි වන උපදෙස්, ප්‍රමිති හෝ අවශ්‍යතා සමූහයකි. කෙටියෙන් කිවහොත්, එය යෙදුම් එකිනෙකා සමඟ සන්නිවේදනය කිරීමට ඉඩ සලසන දෙයකි.

 

API යනු දත්ත සමඟ ගනුදෙනු කරන හෝ නිෂ්පාදන හෝ සේවා දෙකක් අතර සන්නිවේදනය සක්‍රීය කරන සියලුම යෙදුම්වල පදනම වේ. එය ජංගම යෙදුමකට හෝ වේදිකාවකට එහි දත්ත වෙනත් යෙදුම්/වේදිකා සමඟ බෙදා ගැනීමට සහ සංවර්ධකයින් සම්බන්ධ කර නොගෙන පරිශීලක අත්දැකීම පහසු කිරීමට බල ගන්වයි. 

මීට අමතරව, APIs මුල සිටම සංසන්දනාත්මක වේදිකාවක් හෝ මෘදුකාංගයක් නිර්මාණය කිරීමේ අවශ්‍යතාවය ඉවත් කරයි. ඔබට වර්තමාන එකක් හෝ වෙනත් වේදිකාවක් හෝ යෙදුමක් භාවිතා කළ හැකිය. මෙම හේතු නිසා, API සංවර්ධන ක්‍රියාවලිය යෙදුම් සංවර්ධකයින් සහ සමාගම් විධායකයින් යන දෙකටම අවධානය යොමු කරයි.

 

API හි වැඩ කිරීම

ඔබ ගුවන් ගමනක් වෙන්කරවා ගැනීමට XYZ යෙදුමක් හෝ වෙබ් අඩවියක් විවෘත කළා යැයි සිතමු. ඔබ පෝරමය පුරවා, පිටත්වීමේ සහ පැමිණීමේ වේලාවන්, නගරය, ගුවන් ගමන් තොරතුරු සහ අනෙකුත් අවශ්‍ය තොරතුරු ඇතුළත් කර, පසුව එය ඉදිරිපත් කළා. තත්පර කිහිපයකින්, මිල, වේලාවන්, ආසන ලබා ගැනීමේ හැකියාව සහ අනෙකුත් විස්තර සමඟින් පියාසැරි ලැයිස්තුවක් තිරය මත දිස්වේ. ඇත්තටම මේක වෙන්නේ කොහොමද?

 

එවැනි දැඩි දත්ත සැපයීම සඳහා, වේදිකාව විසින් ඔවුන්ගේ දත්ත ගබඩාවට ප්‍රවේශ වීමට සහ යෙදුම් වැඩසටහන් අතුරුමුහුණත හරහා අදාළ දත්ත ලබා ගැනීමට ගුවන් සමාගමේ වෙබ් අඩවියට ඉල්ලීමක් යවන ලදී. වෙබ් අඩවිය API Integration වේදිකාවට ලබා දුන් දත්ත සමඟ ප්‍රතිචාර දැක්වූ අතර වේදිකාව එය තිරය මත පෙන්වයි.

 

මෙහිදී, ගුවන් ගමන් වෙන්කරවා ගැනීමේ යෙදුම/වේදිකාව සහ ගුවන් සමාගමේ වෙබ් අඩවිය අවසාන ලක්ෂ්‍ය ලෙස ක්‍රියා කරන අතර API යනු දත්ත හුවමාරු කිරීමේ ක්‍රියාවලිය විධිමත් කරන අතරමැදි වේ. අවසාන ලක්ෂ්‍ය සන්නිවේදනය කිරීම ගැන කතා කරන විට, API ක්‍රම දෙකකින් ක්‍රියා කරයි, එනම්, REST(නියෝජිත රාජ්‍ය මාරුව) සහ SOAP(සරල වස්තු ප්‍රවේශ ප්‍රොටෝකෝලය).

 

ක්‍රම දෙකම ඵලදායි ප්‍රතිඵල ගෙන දුන්නද, a ජංගම යෙදුම් සංවර්ධන සමාගම SOAP API බර සහ වේදිකාව මත රඳා පවතින බැවින් SOAP වලට වඩා REST කැමති වේ.

 

API ජීවන චක්‍රය අවබෝධ කර ගැනීමට සහ API විස්තරාත්මකව ක්‍රියා කරන ආකාරය දැන ගැනීමට, අදම අපගේ විශේෂඥයින් අමතන්න!

 

API සංවර්ධනය සඳහා මෙවලම්

API නිර්මාණය කිරීමේ ක්‍රියාවලියට සවිකර ඇති API සැලසුම් මෙවලම් සහ තාක්ෂණයන් රාශියක් පවතින අතර, සංවර්ධකයින් සඳහා API සංවර්ධනය කිරීම සඳහා ජනප්‍රිය API සංවර්ධන තාක්ෂණයන් සහ මෙවලම් වන්නේ:

 

  • Apigee

API ඒකාබද්ධ කිරීමේ ප්‍රවේශයක් නැවත ස්ථාපිත කිරීම මගින් සංවර්ධකයින්ට සහ ව්‍යවසායකයින්ට ඩිජිටල් පරිවර්තනයේ ජයග්‍රහණය කිරීමට සහාය වන Google හි API කළමනාකරණ සැපයුම්කරු වේ.

 

  • APIMatic සහ API ට්‍රාන්ස්ෆෝමරය

මේවා API සංවර්ධනය සඳහා වෙනත් ජනප්‍රිය මෙවලම් වේ. ඔවුන් API-විශේෂිත ආකෘතිවලින් උසස් තත්ත්වයේ SDK සහ කේත කොටස් තැනීමට සහ ඒවා RAML, API බ්ලූප්‍රින්ට් වැනි වෙනත් පිරිවිතර සැකසීම් බවට පරිවර්තනය කිරීමට නවීන ස්වයංක්‍රීය උත්පාදන මෙවලම් පිරිනමයි.

 

  • API විද්‍යාව 

මෙම මෙවලම මූලික වශයෙන් අභ්‍යන්තර API සහ බාහිර API යන දෙකෙහිම ක්‍රියාකාරීත්වය ඇගයීම සඳහා භාවිතා කරයි.

 

  • API Serverless Architecture 

මෙම නිෂ්පාදන ක්ලවුඩ් පාදක සේවාදායක යටිතල ව්‍යුහයේ ආධාරයෙන් API සැලසුම් කිරීම, ගොඩනැගීම, ප්‍රකාශනය කිරීම සහ සත්කාරකත්වය සැපයීම සඳහා ජංගම යෙදුම් සංවර්ධකයින්ට සහාය වේ.

 

  • API-වේදිකාව

මෙය වෙබ් API සංවර්ධනය සඳහා සුදුසු විවෘත මූලාශ්‍ර PHP රාමු වලින් එකකි.

 

  • Aut0

එය API සත්‍යාපනය කිරීමට සහ අවසර දීමට භාවිතා කරන අනන්‍යතා කළමනාකරණ විසඳුමකි.

 

  • ClearBlade

එය ඔබගේ ක්‍රියාවලියට IoT තාක්ෂණය වැලඳ ගැනීම සඳහා API කළමනාකරණ සැපයුම්කරුවෙකි.

 

  • GitHub

මෙම විවෘත මූලාශ්‍ර git ගබඩා සත්කාරක සේවාව සංවර්ධකයින්ට කේත ගොනු කළමනාකරණය කිරීමට, ඉල්ලීම් අදින්න, අනුවාද පාලනය සහ කණ්ඩායම පුරා බෙදා හරින අදහස් කිරීමට ඉඩ දෙයි. එය ඔවුන්ගේ කේතය පුද්ගලික ගබඩාවල සුරැකීමට ද ඉඩ සලසයි.

 

  • තැපැල්කරු

එය මූලික වශයෙන් API මෙවලම් දාමයක් වන අතර එය සංවර්ධකයින්ට ඔවුන්ගේ API හි ක්‍රියාකාරිත්වය ධාවනය කිරීමට, පරීක්ෂා කිරීමට, ලේඛනගත කිරීමට සහ ඇගයීමට බලය ලබා දෙයි.

 

  • ස්වැගර්

එය API සංවර්ධන මෘදුකාංග සඳහා භාවිතා කරන විවෘත මූලාශ්‍ර රාමුවකි. GettyImages සහ Microsoft වැනි විශාල තාක්ෂණික දැවැන්තයින් Swagger භාවිතා කරයි. ලෝකය API වලින් පිරී ඇතත්, API තාක්ෂණයේ වරප්‍රසාද භාවිතා කිරීමේ විශාල පරතරයක් තවමත් පවතී. සමහර APIs යෙදුමට ඒකාබද්ධ වීම සුළඟක් බවට පත් කරන අතර අනෙක් ඒවා එය බියකරු සිහිනයක් බවට පත් කරයි.

 

කාර්යක්ෂම API එකක විශේෂාංග තිබිය යුතුය

  • කාල මුද්දර වෙනස් කිරීම හෝ නිර්ණායක අනුව සොයන්න

යෙදුමක තිබිය යුතු ප්‍රමුඛතම API විශේෂාංගය වන්නේ වෙනස් කිරීමේ වේලා මුද්‍රා/නිර්ණායක අනුව සෙවීමයි. API විසින් පරිශීලකයින්ට දිනයක් වැනි විවිධ නිර්ණායක මත පදනම්ව දත්ත සෙවීමට ඉඩ දිය යුතුය. මෙයට හේතුව එය පළමු මූලික දත්ත සමමුහුර්තකරණයෙන් පසුව අප සලකා බලන වෙනස්කම් (යාවත්කාලීන කිරීම, සංස්කරණය කිරීම සහ මකා දැමීම) වීමයි.

 

  • පේජිං 

බොහෝ අවස්ථාවලදී, සම්පූර්ණ දත්ත වෙනස් වී ඇති බව දැකීමට අපට අවශ්‍ය නැත, නමුත් එය දෙස බැලීම පමණි. එවැනි අවස්ථාවක, එක් වරකදී කොපමණ දත්ත ප්‍රමාණයක් පෙන්විය යුතුද සහ කුමන සංඛ්‍යාතයකින්ද යන්න තීරණය කිරීමට API සමත් විය යුතුය. එය අවසාන පරිශීලකයාට අංකය ගැන ද දැනුම් දිය යුතුය. ඉතිරි දත්ත පිටු වලින්.

 

  • වර්ග කිරීම

අවසාන පරිශීලකයාට සියලුම දත්ත පිටු එකින් එක ලැබෙන බව සහතික කිරීම සඳහා, API විසින් වෙනස් කරන වේලාවට හෝ වෙනත් කොන්දේසියකට අනුව දත්ත වර්ග කිරීමට පරිශීලකයින්ට බලය ලබා දිය යුතුය.

 

  • JSON සහාය හෝ විවේකය

අනිවාර්ය නොවන නමුත්, ඵලදායි API සංවර්ධනය සඳහා ඔබේ API RESTful (හෝ JSON සහාය (REST) ​​සැපයීම) ලෙස සලකා බැලීම හොඳය. REST API අස්ථායී, සැහැල්ලු බරින් යුක්ත වන අතර, එය අසාර්ථක වුවහොත් උඩුගත ජංගම යෙදුම් ක්‍රියාවලිය නැවත උත්සාහ කිරීමට ඔබට ඉඩ සලසයි. SOAP සම්බන්ධයෙන් මෙය තරමක් දුෂ්කර ය. ඊට අමතරව, JSON හි වාක්‍ය ඛණ්ඩය බොහෝ ක්‍රමලේඛන භාෂාවලට සමාන වන අතර, ජංගම යෙදුම් සංවර්ධකයෙකුට එය වෙනත් ඕනෑම භාෂාවකට විග්‍රහ කිරීම පහසු කරයි.

 

  • OAuth හරහා අවසර දීම

ඔබගේ යෙදුම් වැඩසටහන් අතුරුමුහුණත OAuth හරහා අවසර දීම නැවත අවශ්‍ය වේ, මන්ද එය වෙනත් ක්‍රමවලට වඩා වේගවත් බැවින් ඔබට බොත්තමක් මත ක්ලික් කර එය සිදු කර ඇත.

 

කෙටියෙන් කිවහොත්, සැකසුම් කාලය අවම විය යුතුය, ප්‍රතිචාර කාලය හොඳ විය යුතුය, සහ ආරක්‍ෂක මට්ටම ඉහළ විය යුතුය. ඔබගේ යෙදුම සුරක්ෂිත කිරීම සඳහා API සංවර්ධන හොඳම භාවිතයන් සඳහා උත්සාහයන් යෙදීම ඉතා වැදගත් වේ, සියල්ලට පසු, එය දත්ත ගොඩක් සමඟ කටයුතු කරයි.

 

API හි පාරිභාෂිතයන්

 

  1. API යතුර - API පරාමිතියක් හරහා ඉල්ලීමක් පරීක්ෂා කර ඉල්ලුම්කරු තේරුම් ගත් විට. සහ අවසර ලත් කේතය ඉල්ලීම් යතුරට ඇතුළු වී API යතුරක් යැයි කියනු ලැබේ.
  2. අන්ත ලක්ෂ්‍යය - එක් පද්ධතියකින් API තවත් පද්ධතියක් සමඟ අන්තර්ක්‍රියා කරන විට, සන්නිවේදන නාලිකාවේ එක් කෙළවරක් අවසන් ලක්ෂ්‍යයක් ලෙස හැඳින්වේ.
  3. JSON - JSON හෝ Javascript වස්තු API ඉල්ලීම් පරාමිති සහ ප්‍රතිචාර ශරීරය සඳහා භාවිතා කරන දත්ත ආකෘතියක් ලෙස භාවිතා කරයි. 
  4. GET – සම්පත් ලබා ගැනීම සඳහා API හි HTTP ක්‍රමය භාවිතා කිරීම
  5. POST – එය සම්පත් ගොඩනැගීම සඳහා RESTful API හි HTTP ක්‍රමයයි. 
  6. OAuth - එය කිසිදු අක්තපත්‍රයක් බෙදා නොගෙන පරිශීලකයාගේ පැත්තෙන් ප්‍රවේශය ලබා දෙන සම්මත අවසර රාමුවකි. 
  7. REST - උපාංග/පද්ධති දෙක අතර සන්නිවේදනයේ කාර්යක්ෂමතාව වැඩි කරන වැඩසටහන්කරණය. REST සම්පූර්ණ දත්ත නොව අවශ්‍ය එකම දත්ත බෙදා ගනී. මෙම ගෘහ නිර්මාණ ශිල්පය මත බලාත්මක කර ඇති පද්ධති 'RESTful' පද්ධති යැයි කියනු ලබන අතර, RESTful පද්ධති සඳහා වඩාත්ම ප්‍රබල උදාහරණය වන්නේ ලෝක ව්‍යාප්ත ජාලයයි.
  8. SOAP - SOAP හෝ සරල වස්තු ප්‍රවේශ ප්‍රොටෝකෝලය යනු පරිගණක ජාල තුළ වෙබ් සේවා ක්‍රියාත්මක කිරීමේදී ව්‍යුහගත තොරතුරු බෙදාගැනීම සඳහා වන පණිවිඩකරණ ප්‍රොටෝකෝලයකි.
  9. ප්‍රමාදය - එය API සංවර්ධන ක්‍රියාවලියක් විසින් ඉල්ලීමේ සිට ප්‍රතිචාර දක්වා ගතවන මුළු කාලය ලෙස අර්ථ දැක්වේ.
  10. අනුපාත සීමා කිරීම - එයින් අදහස් කරන්නේ පරිශීලකයෙකුට වරකට API වෙත පහර දිය හැකි ඉල්ලීම් ගණන සීමා කිරීමයි.

 

නිවැරදි API ගොඩනැගීම සඳහා හොඳම භාවිතයන්

  • Throttling භාවිතා කරන්න

App Throttling යනු ගමනාගමනය පිටාර ගැලීම, උපස්ථ API නැවත හරවා යැවීම සහ DoS (සේවාව ප්‍රතික්ෂේප කිරීම) ප්‍රහාරවලින් එය ආරක්ෂා කිරීම සඳහා සලකා බැලිය යුතු විශිෂ්ට භාවිතයකි.

 

  • ඔබගේ API ද්වාරය බලාත්මක කරන්නා ලෙස සලකන්න

තෙරපුම් නීති, API යතුරු යෙදීම හෝ OAuth සැකසීමේදී, API ද්වාරය බලාත්මක කිරීමේ ලක්ෂ්‍යය ලෙස සැලකිය යුතුය. එය නිවැරදි පරිශීලකයින්ට පමණක් දත්ත වෙත ප්‍රවේශ වීමට ඉඩ සලසන පොලිස් නිලධාරියෙකු ලෙස ගත යුතුය. එය ඔබට පණිවිඩය සංකේතනය කිරීමට හෝ රහස්‍ය තොරතුරු සංස්කරණය කිරීමට බලය ලබා දිය යුතු අතර එමඟින් ඔබේ API භාවිත වන ආකාරය විශ්ලේෂණය කර කළමනාකරණය කළ යුතුය.

 

  • HTTP ක්‍රමය අභිබවා යාමට ඉඩ දෙන්න

සමහර ප්‍රොක්සි GET සහ POST ක්‍රම සඳහා පමණක් සහය දක්වන බැවින්, ඔබ ඔබේ RESTful API හට HTTP ක්‍රමය අභිබවා යාමට ඉඩ දිය යුතුය. එසේ කිරීම සඳහා, අභිරුචි HTTP ශීර්ෂකය X-HTTP-Method-Override භාවිතා කරන්න.

 

  • APIs සහ යටිතල පහසුකම් ඇගයීම

වත්මන් කාලය තුළ, තත්‍ය කාලීන විශ්ලේෂණය ලබා ගත හැකි නමුත්, API සේවාදායකයේ මතක කාන්දුවීම්, CPU කාන්දු වීම හෝ වෙනත් එවැනි ගැටළු ඇති බවට සැක කරන්නේ නම් කුමක් කළ යුතුද? එවැනි තත්වයන් සලකා බැලීමට, ඔබට සංවර්ධකයෙකු රාජකාරියේ තබා ගත නොහැක. කෙසේ වෙතත්, AWS cloud watch වැනි වෙළඳපොලේ ඇති බොහෝ මෙවලම් භාවිතයෙන් ඔබට මෙය පහසුවෙන් සිදු කළ හැක.

 

  • ආරක්ෂාව සහතික කරන්න

ඔබගේ API තාක්‍ෂණය ආරක්‍ෂිත නමුත් පරිශීලක හිතකාමීත්වයේ වියදමින් නොවන බව ඔබ සහතික විය යුතුය. ඕනෑම පරිශීලකයෙකු සත්‍යාපනය සඳහා මිනිත්තු 5කට වඩා වැඩි කාලයක් ගත කරන්නේ නම්, එයින් අදහස් වන්නේ ඔබේ API පරිශීලක-හිතකාමී නොවන බවයි. ඔබගේ API ආරක්ෂිත කිරීමට ඔබට ටෝකන් මත පදනම් වූ සත්‍යාපනය භාවිතා කළ හැක.

 

  • ලේඛගතකිරීම

අවසාන වශයෙන් නොව අවම වශයෙන්, ජංගම යෙදුම් සඳහා API සඳහා පුළුල් ලේඛන නිර්මාණය කිරීම ලාභදායී වන අතර එමඟින් අනෙකුත් ජංගම යෙදුම් සංවර්ධකයින්ට සම්පූර්ණ ක්‍රියාවලිය පහසුවෙන් අවබෝධ කර ගැනීමට සහ වඩා හොඳ පරිශීලක අත්දැකීමක් ලබා දීම සඳහා තොරතුරු භාවිතා කිරීමට ඉඩ සලසයි. වෙනත් වචන වලින් කිවහොත්, ඵලදායී API සංවර්ධන ක්‍රියාවලියේ හොඳ API ලේඛනගත කිරීම ව්‍යාපෘති ක්‍රියාත්මක කිරීමේ කාලය, ව්‍යාපෘති පිරිවැය අඩු කර API තාක්‍ෂණ කාර්යක්ෂමතාව ඉහළ නංවයි.