I-A-Complete-Guide-to-API-Development-

Yintoni i-API kunye nezinto ekufuneka ziqwalaselwe xa uphuhlisa i-API?

I-API (I-Application Programming Interface) yiseti yemiyalelo, imigangatho, okanye iimfuno ezenza isoftware okanye usetyenziso lusebenzise iimpawu okanye iinkonzo zolunye usetyenziso, iqonga, okanye isixhobo seenkonzo ezingcono. Ngamafutshane, yinto evumela ii-apps zinxibelelane.

 

I-API sisiseko sazo zonke ii-apps ezijongene nedatha okanye zivumela unxibelelwano phakathi kweemveliso ezimbini okanye iinkonzo. Ixhobisa isicelo seMobile okanye iqonga lokwabelana ngedatha yayo kunye nezinye ii -apps / iiplatifti kunye nokwenza lula amava omsebenzisi ngaphandle kokubandakanya abaphuhlisi. 

Ukongeza, ii-APIs ziyayisusa imfuneko yokwenza iqonga elithelekisekayo okanye isoftware ukusuka ekuqaleni. Unokusebenzisa eli langoku okanye elinye iqonga okanye usetyenziso. Ngenxa yezi zizathu, inkqubo yophuhliso lwe-API ijolise kubo bobabini abaphuhlisi be-app kunye nabaphathi beenkampani.

 

Ukusebenza kwe-API

Masithi uvule i-XYZ app okanye iwebhusayithi ukubhukisha inqwelomoya. Ugcwalise iphetshana lesicelo, elibandakanya ukuhamba kunye namaxesha okufika, isixeko, ulwazi ngenqwelomoya, kunye nolunye ulwazi oluyimfuneko, emva koko ulungenise. Kwisiqingatha semizuzwana, uluhlu lweenqwelo moya luvela kwiscreen kunye nexabiso, amaxesha, ukufumaneka kwezihlalo, kunye nezinye iinkcukacha. Kwenzeka njani oku ngokwenene?

 

Ukubonelela ngedatha enjalo engqongqo, iqonga lithumele isicelo kwiwebhusayithi ye-airline ukufikelela kwi-database yabo kunye nokufumana idatha efanelekileyo ngokusebenzisa ujongano lweprogram yesicelo. Iwebhusayithi iphendule ngedatha apho uHlanganiso lwe-API luhanjiswe kwiqonga kwaye iqonga libonise kwisikrini.

 

Apha, i-app yokubhukisha inqwelomoya/iqonga kunye newebhusayithi yenqwelomoya isebenza njengeendawo zokuphela ngelixa i-API iyeyona iphakathi yokuhlengahlengisa inkqubo yokwabelana ngedatha. Xa uthetha malunga nokunxibelelana kwee-endpoints, i-API isebenza ngeendlela ezimbini, ezizezi, i-REST (i-Representational State Transfer) kunye ne-SOAP (iProtocol ye-Simple Object Access).

 

Nangona zombini ezi ndlela zizisa iziphumo ezisebenzayo, a Inkampani yokuphuhlisa isoftware ikhetha REST ngaphezu kweSEPHA kuba ii-APIs zeSEPHA zinzima kwaye zixhomekeke kwiqonga.

 

Ukuqonda umjikelo wobomi be-API kunye nokwazi ukuba isebenza njani i-API ngokweenkcukacha, qhagamshelana neengcali zethu namhlanje!

 

Izixhobo zokuphuhlisa i-API

Ngelixa kukho ubuninzi bezixhobo zoyilo ze-API kunye nobuchwepheshe obuxhotyiswe kwinkqubo yokudala i-API, ubugcisa obudumileyo bophuhliso lwe-API kunye nezixhobo zokuphuhlisa ii-API zabaphuhlisi zezi:

 

  • Apigee

Ingumboneleli wolawulo we-API kaGoogle onceda abaphuhlisi kunye noosomashishini ukuba baphumelele kwinguqu yedijithali ngokuphinda bamisele indlela yoManyano lwe-API.

 

  • I-APIMatic kunye ne-API Transformer

Ezi zezinye izixhobo ezidumileyo zophuhliso lwe-API. Banikezela ngezixhobo zokuvelisa ezizenzekelayo ezintsonkothileyo zokwakha ii-SDK ezikumgangatho ophezulu kunye neziqwengana zekhowudi ezivela kwiifomathi ezithe ngqo ze-API kwaye ziguqulelwe kwezinye iifom zenkcazo, njenge-RAML, i-API Blueprint, njl.

 

  • API Science 

Esi sixhobo sisetyenziselwa ukuvavanya ukusebenza kwee-API zangaphakathi kunye nee-API zangaphandle.

 

  • API Serverless Architecture 

Ezi mveliso zincedisa abaphuhlisi be-app yeselula ekuyileni, ukwakha, ukupapasha, kunye nokubamba ii-APIs ngoncedo lweziseko ze-server ezisekelwe kwifu.

 

  • API-Platform

Esi sesinye sesikhokelo se-PHP esivulelekileyo esilungele uphuhliso lwe-API yewebhu.

 

  • Umbhali0

Sisisombululo solawulo lwesazisi esisetyenziselwa ukuqinisekiswa nokugunyazisa ii-APIs.

 

  • ClearBlade

Ingumboneleli wolawulo we-API wokwamkela itekhnoloji ye-IoT kwinkqubo yakho.

 

  • GitHub

Le nkonzo yokusingatha indawo yokugcina ye-git ivumela abaphuhlisi balawule iifayile zekhowudi, izicelo zotsalo, ulawulo loguqulelo, kunye nezimvo ezisasazwa kulo lonke iqela. Ikwabavumela ukuba bagcine ikhowudi yabo kwiindawo zokugcina zabucala.

 

  • Iposi

Iyisiseko sesixhobo se-API esixhobisa abaphuhlisi ukuba baqhube, bavavanye, babhale, kwaye bavavanye ukusebenza kwe-API yabo.

 

  • swagger

Sisikhokelo somthombo ovulekileyo osetyenziselwa isoftware yophuhliso lwe-API. Iingxilimbela ezinkulu zetekhnoloji ezinjengeGettyImages kunye neMicrosoft isebenzisa iSwagger. Nangona ihlabathi lizele ii-APIs, kusekho i-gap enkulu ekusebenziseni i-perks ye-teknoloji ye-API. Ngelixa ezinye ii-API zenza udibaniso kwi-app ibe yimpepho, ezinye ziyijike ibe liphupha elibi.

 

Kufuneka-Ubeneempawu ze-API esebenzayo

  • Izitampu zohlengahlengiso okanye Khangela ngokwekhrayitheriya

Olona phawu luphambili lwe-API ekufuneka lunayo luhlengahlengiso lwezitampu zexesha/Khangela ngokwemigaqo. I-API kufuneka ivumele abasebenzisi ukuba bakhangele idatha ngokusekelwe kwiikhrayitheriya ezahlukeneyo, njengomhla. Oku kungenxa yokuba lutshintsho (uhlaziyo, uhlele kwaye ucime) esiluqwalasela nje emva kongqamaniso lokuqala lwedatha.

 

  • Ukupasa 

Amaxesha amaninzi, kuyenzeka ukuba asifuni ukubona idatha epheleleyo itshintshiwe, kodwa ikroba nje kuyo. Kwimeko enjalo, i-API kufuneka ikwazi ukumisela ukuba ingakanani idatha enokuboniswa kwindawo enye kwaye ngawaphi amaxesha. Kufuneka kwakhona yazise umsebenzisi wokugqibela malunga nenombolo. amaphepha edatha aseleyo.

 

  • Ukuhlela

Ukuqinisekisa ukuba umsebenzisi wokugqibela ufumana onke amaphepha edatha nganye nganye, i-API kufuneka ixhobise abasebenzisi ukuba bahlele idatha njengexesha lokuguqulwa okanye enye imeko.

 

  • Inkxaso ye-JSON okanye i-REST

Nangona kunganyanzelekanga, kulungile ukuthathela ingqalelo i-API yakho ukuba ibe yi-RESTful (okanye inike inkxaso ye-JSON (REST)) kuphuhliso olusebenzayo lwe-API. I-REST APIs ayinammiselo, ilula, kwaye ikuvumela ukuba uphinde uzame inkqubo yokulayisha i-app yeselula ukuba iyasilela. Oku kunzima kakhulu kwimeko yeSEPHA. Ngaphandle koko, i-syntax ye-JSON ifana neyeelwimi ezininzi zeprogram, eyenza kube lula kumphuhlisi we-app ephathwayo ukuyicazulula kulo naluphi na olunye ulwimi.

 

  • Ugunyaziso nge-OAuth

Kuyafuneka kwakhona ukuba ujongano lwenkqubo yesicelo sakho lugunyazise nge-OAuth kuba ikhawuleza kunezinye iindlela ofuna ukucofa iqhosha kwaye iyenziwe.

 

Ngamafutshane, ixesha lokucubungula kufuneka libe lincinci, ixesha lokuphendula lilungile, kunye nenqanaba lokhuseleko liphezulu. Kubaluleke kakhulu ukubeka iinzame kuphuhliso lwe-API iindlela ezilungileyo zokukhusela isicelo sakho, emva kwayo yonke into, ijongene nemfumba yedatha.

 

Terminology of API

 

  1. I-API Key - Xa isicelo sokukhangela i-API ngeparameter kwaye uqonde umceli. Kwaye ikhowudi egunyazisiweyo idluliselwe kwisitshixo sesicelo kwaye kuthiwa yi-API KEY.
  2. I-Endpoint - Xa i-API esuka kwenye inkqubo isebenzisana nenye inkqubo, enye isiphelo somnxeba wonxibelelwano saziwa njengesiphelo.
  3. I-JSON - i-JSON okanye izinto zeJavascript zisetyenziselwa ukuba yifomathi yedatha esetyenziselwa iiparamitha zesicelo se-APIs kunye nomzimba wokuphendula. 
  4. I-GET – Ukusebenzisa indlela ye-HTTP ye-API yokufumana izixhobo
  5. I-POST-Yindlela ye-HTTP ye-RESTful ye-API yokwakha izixhobo. 
  6. I-OAuth – Sisikhokelo sogunyaziso esisemgangathweni esibonelela ngofikelelo kwicala lomsebenzisi ngaphandle kokwabelana ngazo naziphi iziqinisekiso. 
  7. REST – Inkqubo ephucula ukusebenza kakuhle konxibelelwano phakathi kwezi zixhobo zimbini/iinkqubo. I-REST yabelana ngedatha kuphela efunekayo hayi idatha epheleleyo. Iisistim ezinyanzeliswa kolu lwakhiwo kuthiwa ziinkqubo 'EZIPHUMILEYO', kwaye owona mzekelo ubalaseleyo we-RESTful systems yiWorld Wide Web.
  8. I-SOAP - I-SOAP okanye iProtocol ye-Simple Object Access yiprotocol yemiyalezo yokwabelana ngolwazi olucwangcisiweyo ekuqhutyweni kweenkonzo zewebhu kwiinethiwekhi zekhompyutha.
  9. I-Latency - Ichazwa njengexesha elipheleleyo elithathwa yinkqubo yophuhliso lwe-API ukusuka kwisicelo ukuya kwimpendulo.
  10. Ukunciphisa inqanaba - kuthetha ukukhawulela inani lezicelo umsebenzisi anokuthi alibethe kwi-API ngexesha.

 

IiNgcebiso eziGqwesileyo zoKwakha i-API eLungileyo

  • Sebenzisa i-Throttling

I-App Throttling sisenzo esihle ekufuneka siqwalaselwe ekwalathisa ukuphuphuma kwetrafikhi, i-APIs yokugcina, kunye nokuyikhusela kuhlaselo lwe-DoS (Ukwala iNkonzo).

 

  • Qwalasela isango lakho le-API njengoMnyanzelisi

Ngelixa ukuseta imithetho yokubetha, ukusetyenziswa kwezitshixo ze-API, okanye i-OAuth, isango le-API kufuneka lithathelwe ingqalelo njengendawo yokunyanzeliswa. Kufuneka kuthathwe njengepolisa elivumela kuphela abasebenzisi abafanelekileyo ukuba bafumane ukufikelela kwidatha. Kufuneka ikuxhobise ukubethela umyalezo okanye uhlele ulwazi oluyimfihlo, kwaye ngaloo ndlela, uhlalutye kwaye ulawule indlela i-API yakho esetyenziswa ngayo.

 

  • Vumela indlela ye-HTTP engaphezulu

Kuba ezinye iiproxi zixhasa kuphela iindlela ze-GET kunye ne-POST, kufuneka uyeke i-RESTful API yakho igqithise indlela ye-HTTP. Ngokwenza njalo, sebenzisa i-HTTP Header X-HTTP-Method-Override yesiko.

 

  • Vavanya ii-APIs kunye neziseko zophuhliso

Ngexesha langoku, uhlalutyo lwexesha lokwenyani lunokwenzeka, kodwa kuthekani ukuba umncedisi we-API ukrokrelwa ukuba unememori evuzayo, i-CPU yokucoca, okanye eminye imiba enjalo? Ukuqwalasela iimeko ezinjalo, awukwazi ukugcina umphuhlisi esemsebenzini. Nangona kunjalo, unokwenza oku ngokulula ngokusebenzisa izixhobo ezininzi ezikhoyo kwimarike, njengewotshi yelifu ye-AWS.

 

  • Qinisekisa ukhuseleko

Kuya kufuneka uqinisekise ukuba itekhnoloji yakho ye-API ikhuselekile kodwa hayi ngeendleko zokusebenziseka kakuhle. Ukuba nawuphi na umsebenzisi uchitha ngaphezu kwemizuzu emi-5 ekuqinisekiseni oko kuthetha ukuba i-API yakho ikude nokuba isebenziseka lula. Ungasebenzisa ukuqinisekiswa okusekwe kwi-token ukwenza i-API yakho ikhuseleke.

 

  • amaxwebhu

Okokugqibela kodwa okuncinci, kunenzuzo ukwenza amaxwebhu abanzi e-API yeeapps eziphathwayo ezivumela abanye abaphuhlisi beapp ephathwayo ukuba bayiqonde ngokulula yonke inkqubo kwaye basebenzise ulwazi lokubonelela ngamava angcono omsebenzisi. Ngamanye amazwi, amaxwebhu alungileyo e-API kwinkqubo yophuhliso lwe-API olusebenzayo luya kunciphisa ixesha lokuphunyezwa kweprojekthi, iindleko zeprojekthi kunye nokunyusa ukusebenza kweteknoloji ye-API.