He aha ka API a me nā mea e noʻonoʻo ai i ka hoʻomohala ʻana i kahi API?
ʻO API (Application Programming Interface) he pūʻulu o nā ʻōlelo aʻo, nā maʻamau, a i ʻole nā koi e hiki ai i kahi polokalamu a i ʻole ka polokalamu ke hoʻohana i nā hiʻohiʻona a i ʻole nā lawelawe o kekahi app, platform, a i ʻole nā mea hana no nā lawelawe ʻoi aku ka maikaʻi. I ka pōkole, he mea ia e hiki ai i nā polokalamu ke kamaʻilio me kekahi.
ʻO kahi API ke kumu o nā polokalamu āpau e pili ana i ka ʻikepili a i ʻole hiki ke kamaʻilio ma waena o ʻelua huahana a lawelawe paha. Hāʻawi ia i kahi polokalamu Mobile a i ʻole platform e kaʻana like i kāna ʻikepili me nā polokalamu/platform ʻē aʻe a maʻalahi i ka ʻike mea hoʻohana me ka ʻole o ka hoʻopili ʻana i nā mea hoʻomohala.
Hoʻohui, hoʻopau nā API i ka pono e hana i kahi kahua hoʻohālikelike a i ʻole nā polokalamu mai ka wā kahiko. Hiki iā ʻoe ke hoʻohana i ka mea i kēia manawa a i ʻole kahi papahana a i ʻole app. Ma muli o kēia mau kumu, ʻo ke kaʻina hana hoʻomohala API he mea nui ia no nā mea hoʻomohala app a me nā luna ʻoihana.
Ka hana ʻana o ka API
Inā paha ua wehe ʻoe i kekahi polokalamu XYZ a i ʻole pūnaewele e kākau i kahi lele. Ua hoʻopiha ʻoe i ka palapala, me nā manawa haʻalele a me ka hōʻea ʻana, ke kūlanakauhale, ka ʻike lele, a me nā ʻike pono ʻē aʻe, a laila waiho ʻia. I loko o kahi hapa o kekona, ʻike ʻia kahi papa inoa o nā mokulele ma ka pale me ke kumukūʻai, nā manawa, ka loaʻa o ka noho, a me nā kikoʻī ʻē aʻe. Pehea e hana maoli ai kēia?
No ka hāʻawi ʻana i ia ʻikepili koʻikoʻi, ua hoʻouna ka paepae i kahi noi i ka pūnaewele o ka mokulele e kiʻi i kā lākou waihona a loaʻa i ka ʻikepili kūpono ma o ka papa kuhikuhi papahana. Ua pane ka pūnaewele me ka ʻikepili i hāʻawi ʻia e API Integration i ka paepae a hōʻike ʻia ka paepae ma ka pale.
Ma ʻaneʻi, ʻo ka app/platform a me ka pūnaewele hoʻopaʻa mokulele e hana ma ke ʻano he hopena ʻoiai ʻo API ka mea waena e hoʻomāmā i ke kaʻina kaʻana ʻikepili. Ke kamaʻilio e pili ana i ke kamaʻilio ʻana i nā hopena, hana ka API ma nā ala ʻelua, ʻo ia hoʻi, REST (Representational State Transfer) a me SOAP (Simple Object Access Protocol).
ʻOiai ʻo nā ala ʻelua e lawe mai i nā hopena maikaʻi, a ʻoihana hoʻonohonoho pūnaewele ʻona pūnaewele makemake ʻo REST ma mua o SOAP no ka mea he kaumaha a hilinaʻi nā SOAP API.
No ka hoʻomaopopo ʻana i ke ola o ka API a me ka ʻike pehea e hana ai ka API i nā kikoʻī, e leka uila i kā mākou poʻe loea i kēia lā!
Nā mea hana no ka hoʻomohala ʻana i kahi API
ʻOiai he nui nā mea hana hoʻolālā API a me nā ʻenehana i hoʻolako ʻia i ke kaʻina hana o ka hana ʻana i kahi API, ʻo nā ʻenehana hoʻomohala API kaulana a me nā mea hana no ka hoʻomohala ʻana i nā API no nā mea hoʻomohala:
- Apigee
ʻO Google ka mea hoʻokele hoʻokele API e kōkua i nā mea hoʻomohala a me nā ʻoihana e lanakila i ka hoʻololi kikohoʻe ma o ka hoʻokumu hou ʻana i kahi ala API Integration.
- APIMatic a me API Transformer
ʻO kēia nā mea hana kaulana ʻē aʻe no ka hoʻomohala API. Hāʻawi lākou i nā mea hana hana maʻalahi e kūkulu i nā SDK kiʻekiʻe a me nā snippet code mai nā palapala kikoʻī API a hoʻololi iā lākou i nā ʻano kikoʻī ʻē aʻe, e like me RAML, API Blueprint, etc.
- ʻepekema API
Hoʻohana mua ʻia kēia mea hana no ka loiloi ʻana i ka hana o nā API kūloko a me nā API waho.
- ʻO API Serverless Architecture
Ke kōkua nei kēia mau huahana i nā mea hoʻomohala polokalamu kelepona i ka hoʻolālā ʻana, ke kūkulu ʻana, ka paʻi ʻana, a me ka hoʻokipa ʻana i nā API me ke kōkua o nā ʻōnaehana kikowaena kikowaena.
- API-Platform
ʻO kēia kekahi o ka open-source PHP frameworks i kūpono no ka hoʻomohala ʻana i ka API pūnaewele.
- Kālā0
He hoʻoponopono hoʻokele ʻike i hoʻohana ʻia e hōʻoia a ʻae i nā API.
- ClearBlade
He mea lawelawe hoʻokele API no ka hoʻokomo ʻana i ka ʻenehana IoT i kāu kaʻina hana.
- GitHub
ʻO kēia open-source git repository service hosting e ʻae i nā mea hoʻomohala e hoʻokele i nā faila code, huki noi, mana mana, a me nā ʻōlelo i hoʻohele ʻia ma ka hui. E ʻae iā lākou e mālama i kā lākou code i loko o nā waihona pilikino.
- Kahuhahu
ʻO ia kahi mea hana API e hoʻoikaika i nā mea hoʻomohala e holo, hoʻāʻo, palapala, a loiloi i ka hana o kā lākou API.
- ʻO Swagger
ʻO ia kahi papa hana open-source i hoʻohana ʻia no ka polokalamu hoʻomohala API. Hoʻohana nā ʻenehana nui e like me GettyImages a me Microsoft iā Swagger. ʻOiai ua piha ka honua i nā API, aia nō kahi ākea nui i ka hoʻohana ʻana i nā pono o ka ʻenehana API. ʻOiai e hana ana kekahi mau API i ka hoʻohui ʻana i ka app i ka makani, ua hoʻohuli ʻia kekahi i kahi moeʻuhane.
Pono e loaʻa nā hiʻohiʻona o kahi API kūpono
- Hoʻololi i nā kaha manawa a i ʻole Huli ma nā pae hoʻohālike
ʻO ka hiʻohiʻona API mua loa e loaʻa i kahi polokalamu ʻo ia ka hoʻololi ʻana i nā timestamps / Huli ma nā pae hoʻohālike. Pono ka API e ʻae i nā mea hoʻohana e ʻimi i ka ʻikepili ma muli o nā koina like ʻole, e like me ka lā. ʻO kēia no ka mea ʻo ia nā hoʻololi (hōʻano hou, hoʻoponopono a holoi) a mākou e noʻonoʻo ai ma hope o ka hoʻonohonoho ʻikepili mua.
- Paging
I nā manawa he nui, ʻaʻole makemake mākou e ʻike i ka hoʻololi ʻana o ka ʻikepili piha, akā he ʻike wale nō. Ma ia ʻano hiʻohiʻona, pono i ka API ke hoʻoholo i ka nui o ka ʻikepili e hōʻike ʻia i ka hele hoʻokahi a i ke alapine. Pono e hoʻomaopopo i ka mea hoʻohana hope e pili ana i ka no. o nā ʻaoʻao o ka ʻikepili i koe.
- Hoʻoiho
No ka hōʻoia e loaʻa i ka mea hoʻohana hope nā ʻaoʻao o ka ʻikepili i kēlā me kēia, pono ka API e hāʻawi i nā mea hoʻohana e hoʻokaʻawale i ka ʻikepili e like me ka manawa o ka hoʻololi ʻana a i ʻole kekahi kūlana ʻē aʻe.
- Kākoʻo JSON a i ʻole REST
ʻOiai ʻaʻole koi ʻia, maikaʻi e noʻonoʻo i kāu API he RESTful (a i ʻole hāʻawi ʻana i ke kākoʻo JSON (REST)) no ka hoʻomohala ʻana i ka API kūpono. He mokuʻāina ʻole nā API REST, māmā-kaumaha, a e ʻae iā ʻoe e hoʻāʻo hou i ka hoʻouka ʻana i ke kaʻina hana polokalamu kelepona inā hāʻule. He mea paʻakikī kēia i ka hihia o SOAP. Ma waho aʻe o kēia, ua like ka syntax o JSON me ka hapa nui o nā ʻōlelo papahana, kahi e maʻalahi ai ka mea hoʻomohala polokalamu kelepona e hoʻokaʻawale iā ia i kekahi ʻōlelo ʻē aʻe.
- ʻAe ʻia ma o OAuth
Pono hou e ʻae ʻia kāu polokalamu polokalamu noi ma OAuth no ka mea ʻoi aku ka wikiwiki ma mua o nā ʻano hana ʻē aʻe e pono ai ʻoe e kaomi i kahi pihi a ua pau.
I ka pōkole, pono ka liʻiliʻi o ka manawa hana, maikaʻi ka manawa pane, a me ke kiʻekiʻe o ka palekana. He mea koʻikoʻi loa ka hoʻokomo ʻana i nā hoʻoikaika ʻana i nā hana maikaʻi loa o ka hoʻomohala ʻana i ka API no ka mālama ʻana i kāu noi, ma hope o nā mea a pau, pili ia i kahi puʻu ʻikepili.
Nā huaʻōlelo o API
- API Key - Ke noi ʻia kahi hōʻoia API ma o kahi ʻāpana a hoʻomaopopo i ka mea noi. A ua kau ʻia ke code ʻae ʻia i loko o ke kī noi a ʻōlelo ʻia he API KEY.
- Hopena - Ke hoʻopili ʻia ka API mai kahi ʻōnaehana me kahi ʻōnaehana ʻē aʻe, ʻike ʻia ka ʻaoʻao hoʻokahi o ke ala kamaʻilio he hopena.
- JSON - Hoʻohana ʻia nā mea JSON a i ʻole Javascript e lilo i palapala ʻikepili i hoʻohana ʻia no nā ʻāpana noi API a me ke kino pane.
- GET - Ke hoʻohana nei i ke ala HTTP o API no ka loaʻa ʻana o nā kumuwaiwai
- POST - ʻO ia ke ʻano HTTP RESTful API no ke kūkulu ʻana i nā kumuwaiwai.
- OAuth - He papa hana mana maʻamau e hāʻawi i ke komo mai ka ʻaoʻao o ka mea hoʻohana me ka ʻole o ka hōʻoia ʻana.
- REST - ʻO ka papahana e hoʻonui ai i ka maikaʻi o ke kamaʻilio ma waena o nā ʻaoʻao ʻelua / ʻōnaehana. Hāʻawi ʻo REST i ka ʻikepili wale nō i koi ʻia ʻaʻole ka ʻikepili piha. ʻO nā ʻōnaehana i hoʻokō ʻia ma kēia hoʻolālā ʻana i ʻōlelo ʻia he ʻōnaehana 'RESTful', a ʻo ka laʻana nui loa o nā ʻōnaehana RESTful ʻo ia ka World Wide Web.
- SOAP - SOAP a i ʻole Simple Object Access Protocol he protocol memo no ka kaʻana like ʻana i ka ʻike i kūkulu ʻia i ka hoʻokō ʻana i nā lawelawe pūnaewele ma nā pūnaewele kamepiula.
- Latency - Ua wehewehe ʻia ʻo ia ka nui o ka manawa i lawe ʻia e kahi kaʻina hana hoʻomohala API mai ka noi i ka pane.
- Ka palena o ka helu - ʻo ia hoʻi ka palena ʻana i ka helu o nā noi i hiki i ka mea hoʻohana ke paʻi i kahi API i kēlā me kēia manawa.
Nā hana maikaʻi loa no ke kūkulu ʻana i ka API Pono
- E hoʻohana i ka Throttling
He hana maikaʻi ʻo App Throttling e noʻonoʻo ai no ka hoʻihoʻi ʻana i ke kahe o ke kaʻa, nā API kākoʻo, a me ka pale ʻana iā ia mai nā hoʻouka kaua DoS (Denial of Service).
- E noʻonoʻo i kāu puka API ma ke ʻano he Enforcer
ʻOiai e hoʻonohonoho ana i nā lula throttling, hoʻohana ʻana i nā kī API, a i ʻole OAuth, pono e noʻonoʻo ʻia ka ʻīpuka API ma ke ʻano he wahi hoʻokō. Pono e lawe ʻia ma ke ʻano he cop e ʻae wale i nā mea hoʻohana kūpono ke komo i ka ʻikepili. Pono ia e hāʻawi iā ʻoe i ka hoʻopili ʻana i ka memo a i ʻole hoʻoponopono i ka ʻike huna, a laila, e kālailai a hoʻokele i ka hoʻohana ʻia ʻana o kāu API.
- E ʻae i ke ʻano o ka HTTP
No ke kākoʻo wale ʻana o kekahi mau proxies i nā ʻano GET a me POST, pono ʻoe e ʻae i kāu RESTful API e kāpae i ke ʻano HTTP. No ka hana ʻana pēlā, e hoʻohana i ka HTTP Header X-HTTP-Method-Override.
- E loiloi i nā API a me nā ʻōnaehana
I kēia manawa, hiki ke kiʻi i ka loiloi manawa maoli, akā pehea inā i manaʻo ʻia ka server API e loaʻa nā leaks hoʻomanaʻo, hoʻoheheʻe CPU, a i ʻole nā pilikia like ʻole? No ka noʻonoʻo ʻana i kēlā ʻano kūlana, ʻaʻole hiki iā ʻoe ke mālama i kahi mea hoʻomohala ma ke kuleana. Eia nō naʻe, hiki iā ʻoe ke hana maʻalahi ma o ka hoʻohana ʻana i nā mea hana he nui i loaʻa i ka mākeke, e like me AWS cloud watch.
- E hōʻoia i ka palekana
Pono ʻoe e hōʻoia i ka palekana o kāu ʻenehana API akā ʻaʻole ma ke kumu kūʻai o ka mea hoʻohana. Inā hoʻohana kekahi mea hoʻohana ma mua o 5 mau minuke ma ka hōʻoia ʻana a laila ʻo ia ka mamao o kāu API mai ka hoʻohana ʻana. Hiki iā ʻoe ke hoʻohana i ka hōʻoia e pili ana i nā hōʻailona e hoʻopaʻa i kāu API.
- Ka moʻolelo
ʻO ka mea hope akā ʻaʻole ka mea liʻiliʻi, ʻoi aku ka maikaʻi o ka hana ʻana i nā palapala nui no kahi API no nā polokalamu kelepona e hiki ai i nā mea hoʻomohala polokalamu kelepona ʻē aʻe ke hoʻomaopopo maʻalahi i ke kaʻina holoʻokoʻa a hoʻohana i ka ʻike no ka hāʻawi ʻana i kahi ʻike mea hoʻohana ʻoi aku ka maikaʻi. I nā huaʻōlelo ʻē aʻe, ʻo nā palapala API maikaʻi i ke kaʻina o ka hoʻomohala ʻana i ka API e hoʻemi i ka manawa hoʻokō o ka papahana, ke kumukūʻai o ka papahana a hoʻonui i ka pono ʻenehana API.