Iyini i-API nezinto okufanele zicatshangelwe lapho usungula i-API?

I-API (I-Application Programming Interface) iyisethi yemiyalelo, izindinganiso, noma izimfuneko ezivumela isofthiwe noma uhlelo lokusebenza ukuthi lusebenzise izici noma amasevisi olunye uhlelo lokusebenza, inkundla, noma idivayisi ukuze uthole amasevisi angcono. Ngamafuphi, into evumela izinhlelo zokusebenza ukuthi zixhumane.

 

I-API iyisisekelo sazo zonke izinhlelo zokusebenza ezisebenza ngedatha noma ezivumela ukuxhumana phakathi kwemikhiqizo emibili noma amasevisi. Inika amandla uhlelo lokusebenza Lweselula noma inkundla ukuthi yabelane ngedatha yayo nezinye izinhlelo zokusebenza/izinkundla futhi yenza lula ulwazi lomsebenzisi ngaphandle kokubandakanya onjiniyela. 

Ukwengeza, ama-API aqeda isidingo sokudala inkundla efanayo noma isofthiwe kusukela ekuqaleni. Ungasebenzisa yamanje eyodwa noma enye inkundla noma uhlelo lokusebenza. Ngenxa yalezi zizathu, inqubo yokuthuthukisa i-API igxile kukho kokubili abathuthukisi bohlelo lokusebenza nabaphathi benkampani.

 

Ukusebenza kwe-API

Ake sithi uvule uhlelo lokusebenza lwe-XYZ noma iwebhusayithi ukuze ubhukhe indiza. Ugcwalise ifomu, wahlanganisa izikhathi zokuhamba nezokufika, idolobha, ulwazi lwendiza, nolunye ulwazi oludingekayo, wabe usulithumela. Phakathi nengxenye yamasekhondi, uhlu lwezindiza luvela esikrinini kanye nenani, izikhathi, ukutholakala kwezihlalo, neminye imininingwane. Kwenzeka kanjani lokhu ngempela?

 

Ukuze kuhlinzekwe ngedatha enjalo eqinile, inkundla ithumele isicelo kuwebhusayithi yenkampani yezindiza ukuze ifinyelele kusizindalwazi sayo futhi ithole idatha efanele ngesixhumi esibonakalayo sohlelo lohlelo lokusebenza. Iwebhusayithi iphendule ngedatha ukuhlanganiswa kwe-API okulethwe endaweni yesikhulumi kanye nenkundla eyibonisa esikrinini.

 

Lapha, uhlelo lokusebenza/inkundla yokubhukha indiza kanye newebhusayithi yenkampani yezindiza isebenza njengezindawo zokuphela ngenkathi i-API iyisikhungo esiqondisa kahle inqubo yokwabelana ngedatha. Uma ukhuluma ngokuthinta izindawo zokugcina, i-API isebenza ngezindlela ezimbili, okungukuthi, i-REST(Representational State Transfer) kanye ne-SOAP(I-Simple Object Access Protocol).

 

Nakuba zombili lezi zindlela ziletha imiphumela ephumelelayo, a inkampani yokuthuthukisa uhlelo lokusebenza leselula ikhetha i-REST kune-SOAP njengoba ama-SOAP APIs esindayo futhi ancike endawenikazi.

 

Ukuze uqonde umjikelezo wempilo we-API kanye nolwazi lokuthi i-API isebenza kanjani ngokuningiliziwe, xhumana nochwepheshe bethu namuhla!

 

Amathuluzi Okuthuthukisa i-API

Yize kukhona inqwaba yamathuluzi okuklama kwe-API nobuchwepheshe obufakwe ohlelweni lokudala i-API, ubuchwepheshe obudumile bokuthuthukisa i-API namathuluzi okuthuthukisa ama-API onjiniyela yilawa:

 

• I-Apigee

Iwumhlinzeki wokuphatha we-API we-Google osiza abathuthukisi nosomabhizinisi ukuthi baphumelele ekuguqulweni kwedijithali ngokuphinda basungule indlela yokuhlanganisa i-API.

 

• I-APIMatic kanye ne-API Transformer

Lawa amanye amathuluzi adumile okuthuthukiswa kwe-API. Banikeza amathuluzi ayinkimbinkimbi okwenza okuzenzakalelayo ukuze kwakhiwe ama-SDK ekhwalithi ephezulu namazwibela ekhodi asuka kumafomethi aqondene ne-API futhi awaguqule abe ezinye izinhlobo zokucaciswa, njenge-RAML, i-API Blueprint, njll.

 

• Isayensi ye-API 

Leli thuluzi ngokuyinhloko lisetshenziselwa ukuhlola ukusebenza kwakho kokubili ama-API angaphakathi nama-API angaphandle.

 

• I-API Serverless Architecture 

Le mikhiqizo isiza onjiniyela bohlelo lokusebenza lweselula ekwakheni, ekwakheni, ekushicileleni, nasekubambeni ama-API ngosizo lwengqalasizinda yeseva esekelwe emafini.

 

• I-API-Platform

Lolu ngolunye lwezinhlaka ze-PHP zomthombo ovulekile ezifanele ukuthuthukiswa kwe-web API.

 

• Umlobi0

Kuyisixazululo sokuphatha umazisi esisetshenziselwa ukuqinisekisa nokugunyaza ama-API.

 

• ClearBlade

Ingumhlinzeki wokuphatha we-API wokwamukela ubuchwepheshe be-IoT enqubweni yakho.

 

• GitHub

Le sevisi yokubamba ikhosombe le-git yomthombo ovulekile ivumela onjiniyela ukuthi baphathe amafayela ekhodi, izicelo zokudonsa, ukulawula inguqulo, namazwana asatshalaliswa kulo lonke iqembu. Iphinde ibavumele ukuthi bagcine amakhodi abo kumakhosombe ayimfihlo.

 

• Postman

Iwuchungechunge lwamathuluzi we-API olunikeza amandla onjiniyela ukuthi baqalise, bahlole, babhale phansi, futhi bahlole ukusebenza kwe-API yabo.

 

• I-Swagger

Kuwuhlaka lomthombo ovulekile olusetshenziselwa isofthiwe yokuthuthukisa i-API. Iziqhwaga ezinkulu zobuchwepheshe ezifana ne-GettyImages ne-Microsoft zisebenzisa i-Swagger. Nakuba umhlaba ugcwele ama-API, kusenegebe elikhulu ekusebenziseni izinzuzo zobuchwepheshe be-API. Ngenkathi amanye ama-API enza ukuhlanganiswa nohlelo lokusebenza kube umoya oshisayo, amanye akwenza kube yiphupho elibi.

 

Okufanele Ube Nezici ze-API Esebenzayo

• Izitembu zesikhathi zokushintsha noma Sesha ngokwemibandela

Isici esiphambili se-API okufanele uhlelo lokusebenza lube nazo Izitembu zesikhathi Zokushintsha/Ukusesha ngemibandela. I-API kufanele ivumele abasebenzisi baseshe idatha ngokusekelwe kumibandela ehlukene, njengedethi. Lokhu kungenxa yokuthi izinguquko (ukubuyekeza, ukuhlela nokususa) esizicabangela ngemva nje kokuvumelanisa kwedatha kokuqala.

 

• Ukupaka 

Izikhathi eziningi, kuyenzeka ukuthi asifuni ukubona idatha ephelele ishintshiwe, kodwa nje amazwibela ayo. Esimeni esinjalo, i-API kufanele ikwazi ukunquma ukuthi ingakanani idatha ezoboniswa ngesikhathi esisodwa futhi ngasiphi imvamisa. Kufanele futhi yazise umsebenzisi wokugcina mayelana no-cha. yamakhasi edatha asele.

 

• Ukuhlunga

Ukuqinisekisa ukuthi umsebenzisi wokugcina uthola wonke amakhasi edatha ngalinye ngalinye, i-API kufanele inikeze abasebenzisi amandla okuhlunga idatha ngokwesikhathi sokushintsha noma esinye isimo.

 

• Ukusekelwa kwe-JSON noma i-REST

Nakuba kungaphoqelekile, kuhle ukucabangela i-API yakho njenge-RESTful (noma ukunikeza usekelo lwe-JSON(REST)) ukuze kuthuthukiswe i-API ngempumelelo. Ama-REST APIs awanasimo, anesisindo esincane, futhi akuvumela ukuthi uzame kabusha inqubo yokulayisha uhlelo lokusebenza uma yehluleka. Lokhu kunzima kakhulu endabeni ye-SOAP. Ngaphandle kwalokho, i-syntax ye-JSON ifana neyezilimi eziningi zokuhlela, okwenza kube lula kumthuthukisi wohlelo lokusebenza lweselula ukuthi ayihlukanisele kunoma yiluphi olunye ulimi.

 

• Ukugunyazwa nge-OAuth

Kuyadingeka futhi ukuthi isixhumi esibonakalayo sohlelo lwakho lokusebenza sigunyaze nge-OAuth njengoba ishesha kunezinye izindlela udinga nje ukuchofoza inkinobho bese sekuqedile.

 

Ngamafuphi, isikhathi sokucubungula kufanele sibe sincane, isikhathi sokuphendula sibe sihle, nezinga lokuvikeleka libe phezulu. Kubaluleke kakhulu ukubeka imizamo ekuthuthukiseni i-API imikhuba yokuvikela uhlelo lwakho lokusebenza, ngemva kwakho konke, isebenzisana nenqwaba yedatha.

 

Terminologies of API

 

1. Ukhiye we-API - Uma isicelo sokuhlola i-API ngepharamitha futhi uqonde ocelayo. Futhi ikhodi egunyaziwe idluliselwe kukhiye wesicelo futhi kuthiwa YI-API KEY.
2. I-Endpoint - Uma i-API evela ohlelweni olulodwa ixhumana nolunye uhlelo, umkhawulo owodwa wesiteshi sokuxhumana waziwa ngokuthi i-endpoint.
3. I-JSON - Izinto ze-JSON noma ze-Javascript zisetshenziselwa ukuba ifomethi yedatha esetshenziselwa amapharamitha esicelo se-API kanye nendikimba yokuphendula. 
4. GET - Ukusebenzisa indlela ye-API ye-HTTP yokuthola izinsiza
5. I-POST - Kuyindlela ye-HTTP ye-RESTful API yezinsiza zokwakha. 
6. I-OAuth – Iwuhlaka olujwayelekile lokugunyaza olunikeza ukufinyelela ohlangothini lomsebenzisi ngaphandle kokwabelana nganoma yiziphi iziqinisekiso. 
7. REST - Uhlelo oluthuthukisa ukusebenza kahle kokuxhumana phakathi kwamadivayisi/amasistimu womabili. I-REST yabelana ngedatha kuphela edingekayo hhayi idatha ephelele. Amasistimu asetshenziswa kulokhu kwakhiwa kuthiwa amasistimu 'E-RESTful', futhi isibonelo esihle kakhulu sezinhlelo ze-RESTful yi-World Wide Web.
8. I-SOAP - I-SOAP noma I-Simple Object Access Protocol iyiphrothokholi yemiyalezo yokwabelana ngolwazi oluhlelekile ekwenzeni izinsiza zewebhu kumanethiwekhi amakhompyutha.
9. Ukubambezeleka - Kuchazwa njengenani eliphelele lesikhathi esithathwe inqubo yokuthuthukisa i-API kusukela ekucelweni kuya empendulweni.
10. Ukunciphisa Isilinganiso - kusho ukukhawulela inani lezicelo umsebenzisi angazifinyelela ku-API ngesikhathi.

 

Imikhuba Engcono Kakhulu Yokwakha I-API Elungile

• Sebenzisa i-Throttling

I-App Throttling kuwumkhuba omuhle okufanele ucatshangelwe ekuqondiseni kabusha ukuchichima kwethrafikhi, ama-API ayisipele, nokuwuvikela ekuhlaselweni kwe-DoS (Denial of Service).

 

• Cabangela isango lakho le-API njenge-Enforcer

Ngenkathi isetha imithetho yokuphonseka, ukusetshenziswa kokhiye be-API, noma i-OAuth, isango le-API kufanele libhekwe njengendawo yokuphoqelela. Kufanele kuthathwe njengephoyisa elivumela kuphela abasebenzisi abalungile ukuthi bathole ukufinyelela kudatha. Kufanele ikunikeze amandla okubethela umlayezo noma uhlele ulwazi oluyimfihlo, futhi ngalokho, uhlaziye futhi ulawule ukuthi i-API yakho isetshenziswa kanjani.

 

• Vumela ukukhipha indlela ye-HTTP

Njengoba amanye ama-proxi asekela kuphela izindlela ze-GET ne-POST, udinga ukuvumela i-RESTful API yakho ukuba iqede indlela ye-HTTP. Ngokwenza kanjalo, sebenzisa i-HTTP Header X-HTTP-Method-Override yangokwezifiso.

 

• Hlola ama-API nengqalasizinda

Esikhathini samanje, kungenzeka ukuthola ukuhlaziywa kwesikhathi sangempela, kodwa kuthiwani uma iseva ye-API isolwa ngokuvuza kwenkumbulo, ukukhipha i-CPU, noma ezinye izinkinga ezinjalo? Ukuze ucabangele izimo ezinjalo, awukwazi ukugcina unjiniyela esemsebenzini. Nokho, lokhu ungakwenza kalula ngokusebenzisa amathuluzi amaningi atholakala emakethe, njengewashi lefu le-AWS.

 

• Qinisekisa ukuphepha

Kufanele uqinisekise ukuthi ubuchwepheshe bakho be-API buvikelekile kodwa hhayi ngezindleko zokusebenziseka kalula. Uma noma yimuphi umsebenzisi echitha ngaphezu kwamaminithi angu-5 ekuqinisekiseni lokho kusho ukuthi i-API yakho isekude ekubeni isebenziseke kalula. Ungasebenzisa ukuqinisekiswa okususelwa kumathokheni ukwenza i-API yakho ivikeleke.

 

• Amadokhumenti

Okokugcina, kunenzuzo ukudala imibhalo ebanzi ye-API yezinhlelo zokusebenza zeselula evumela abanye abathuthukisi bezinhlelo zokusebenza zeselula baqonde kalula yonke inqubo futhi basebenzise ulwazi ukuze banikeze ulwazi olungcono lomsebenzisi. Ngamanye amazwi, imibhalo emihle ye-API ohlelweni lokuthuthukiswa kwe-API kuzonciphisa isikhathi sokuqaliswa kwephrojekthi, izindleko zephrojekthi futhi kukhuphule ukusebenza kahle kobuchwepheshe be-API.