Kumonekta sa mga API Nang Walang Code: 8 Mga Hakbang

2024 May -akda: John Day | [email protected]. Huling binago: 2024-01-30 13:11

Ang gabay na ito ay idinisenyo para sa mga taong may nais na makamit na nangangailangan ng paggamit ng isang API, ngunit hindi sigurado kung paano magsisimula. Alam mo na kung bakit kapaki-pakinabang ang kakayahang gumana sa isang API, at ipapakita sa iyo ng gabay na ito kung paano ito gagawin.

Kung katulad mo yan, swerte ka! Narito kami upang ipaliwanag kung paano gumana sa mga API, kung paano basahin ang mga doc ng API, at kung paano talaga gagamitin ang data na babalik mula sa isang API.

Nagdala kami ng isang kaibigan upang mas gawing mas madali ang paglalakbay.

Kilalanin ang Slash

Ang Slash ay kaibig-ibig, kaibig-ibig na aso ni Michelle (nakalarawan sa itaas). Si Michelle ay isang software engineer na nagtatayo ng mga API. Talagang nasisiyahan si Michelle sa kanyang trabaho at kumuha ng inspirasyon mula sa kanyang mga API sa pagtatrabaho sa pagsasanay sa Slash.

Tulad ng nalalaman mo, ang isang API ay isang koleksyon ng mga utos na maibibigay ng isang gumagamit sa isang serbisyo sa web kasama ang isang hanay ng mga tugon na tumutugma sa kahilingan. Sinanay ni Michelle si Slash upang gawin ang pareho. Si Slash ay isang mabuting bata, alam ang iba't ibang mga utos, at palaging tumutugon nang tama hangga't bibigyan mo siya ng isang kahilingan na tinuruan siya. Kapag naging labis siyang nasasabik, nababaliw ang kanyang buntot - hindi ito isang bagay na itinuro sa kanya ni Michelle na nauugnay sa mga API, dahil lamang sa siya ay isang kaibig-ibig na alaga at talagang nasisiyahan sa kanyang pagsasanay!

Hakbang 1: Magpasya Kung Ano ang Kailangan mong API

Anong impormasyon ang hinahanap mo o nais mong baguhin?

Sinusubukan mo bang kunin ang lahat ng mga post sa Instagram ni @ dougthepug? Marahil nais mong awtomatikong mag-tweet sa sinumang sumusunod sa kaba ng iyong aso (dahil kahit na hindi makapagsalita ang mga aso, maraming sasabihin, alam naming sigurado ang Slash).

Kung alam mo na ang site o API na sinusubukan mong kumonekta, direktang pumunta sa Hakbang 2. Kung sinusubukan mong maghanap ng data, ngunit hindi sigurado kung saan magsisimula, ang Google ay iyong kaibigan. Maghanap para sa "[bagay na interesado ka] API" at makita kung ano ang darating. Maaari kang magulat kung magkano ang impormasyon doon.

Kung nais mo ng isang simpleng halimbawa ng API, maaari mong gamitin ang isang ginawa ni Michelle habang sinasanay ang Slash. Mayroon itong ilan sa kanyang mga paboritong utos tulad ng pagkuha ng mga bola at paghuhukay ng mga butas. Gagamitin namin ito sa buong natitirang mga halimbawa.

Hakbang 2: Hanapin ang Mga Doktor ng API

Ang mga API na ibinigay ng mga kilalang kumpanya ay dapat magkaroon ng masusing dokumentasyon kung paano ito gagamitin.

Upang hanapin ang mga ito, i-google ang "[Insert Company] dokumentasyon ng API" o "[Insert Company] developer".

Ang mga resulta ay dapat magdala sa iyo sa developer portal. Maghanap ng isang link na nagsasabing "Docs", "Documentation", "Reference" o "Teknikal na Sanggunian".

Sa loob ng mga doc, maaaring kailanganin mong maghanap para sa tukoy na API na gusto mo dahil minsan maraming mga pagpipilian. Ang Facebook, halimbawa, ay may magkakahiwalay na mga API para sa marketing, mga ad, pahina, at marami pa.

Kung ang API na nais mong kumonekta ay hindi kilalang kilala (tulad ng Slash's) maaaring kailangan mong tanungin ang developer para sa dokumentasyon. Maaari silang magkaroon ng isang PDF na naglalaman ng impormasyong kailangan mo o online na dokumentasyon na hindi nakalista sa kanilang website.

Kung napalampas mo ang link sa nakaraang hakbang, ang mga dokumento ng Slash's API ay matatagpuan dito.

Hakbang 3: Hanapin ang Endpoint

Ang API docs ay maaaring magmukhang nakakatakot, ngunit kapag alam mo kung ano ang hahanapin sa mga ito ay kadalasang mahusay na nakabalangkas at medyo na-standardize.

Ang unang bagay na hahanapin ay ang naaangkop na (mga) endpoint. Dapat mayroong isang endpoint na naaayon sa bawat uri ng data na gusto mo. Ang isang endpoint ay maaaring magmukhang ganito:

slashtheapidog.com/api/bones/{id}

o basta

/ buto

Ang dokumentasyon ay dapat magkaroon ng isang listahan ng mga endpoint. Maaari silang maging nangungunang antas sa mga doc o sa ilalim ng isang seksyon na tinatawag na "sanggunian", "mga endpoint", o "mga pamamaraan". Upang mahanap ang tamang endpoint, hanapin ang pangalan na tumutugma sa data na iyong hinahanap. Halimbawa, kung nais mo ang isang listahan ng lahat ng mga butas na hinukay ni Slash, / ang mga butas ay marahil ang tama. Sa anumang kaso, ang bawat endpoint ay dapat magkaroon ng isang paglalarawan upang matulungan na ipaliwanag kung ano ang ginagawa nito.

Mula sa kanyang mga dokumento, ito ang mga endpoint sa Slash's API na nauugnay sa mga butas:

GET

GET

POST

PUT

POST

Hakbang 4: Tukuyin ang Iyong Uri ng Kahilingan

Ngayon natagpuan mo ang tamang endpoint, kailangan mong matukoy ang uri ng kahilingan upang maipadala ito.

Mayroong 4 na magkakaibang uri ng mga kahilingan:

GET

Ang isang kahilingan sa GET ay kung paano mo hilingin sa API na tumugon sa isang bagay na mayroon ito, madalas na data. Maaari kang humiling ng tukoy na impormasyon tungkol sa isang item o isang pangkat ng mga item batay sa endpoint at mga parameter. Ito ang katumbas ng paghingi sa Slash na dalhin sa iyo ang isa sa kanyang mga buto o lahat ng kanyang mga buto.

POST

Ang isang kahilingan sa POST ay kung paano mo sasabihin sa API na lumikha ng bago. Ito ay katulad sa pagtatanong sa Slash na maghukay (lumikha) ng isang bagong butas para sa iyo.

Ilagay

Ang isang kahilingan sa PUT ay kung paano mo sasabihin sa API na mag-update ng isang bagay na dating nilikha. Ito ay katulad sa pagtatanong kay Slash na maghukay ng mas malalim (i-update) sa butas na kanyang hinukay.

TANGGALIN

Ang isang kahilingan na TANGGAL ay kung paano mo sasabihin sa API na tanggalin ang isang bagay na dating nilikha. Ito ay katulad ng pagtatanong kay Slash upang magtakip (tanggalin) ang isang butas na dati niyang hinukay.

Isipin ang tungkol sa apat na uri na ito. Nakakakuha ka ba ng impormasyon, lumilikha ng isang bagong entry, binabago ang isang mayroon nang entry, o tinatanggal ang isa? Sasabihin sa iyo ng sagot na iyon nang eksakto kung anong uri ng kahilingan ang kailangan mo.

Hakbang 5: Maunawaan ang Mga Parameter

Maraming mga kahilingan ang nangangailangan ng karagdagang mga parameter. Ang mga parameter ay ang mga detalye ng iyong kahilingan. Halimbawa, kung nais mong dalhin sa iyo ng Slash ang lahat ng mga bola na pula, kailangan mong tukuyin ang kulay. Kung nais mong lumikha siya ng isang bagong butas, kailangan mong sabihin sa kanya kung saan ito ilalagay at kung gaano kalalim ang maghukay.

Ang dokumentasyon ng API na iyong tinutukoy ay dapat magkaroon ng isang seksyon na tinatawag na "Mga Parameter" o "Mga Pagpipilian" para sa bawat uri ng endpoint at kahilingan. Bigyang pansin kung aling mga parameter ang kinakailangan dahil ang ilan ay opsyonal. Kung ang isang parameter ay minarkahan bilang opsyonal, ang mga doc ay maaaring magbigay ng isang halimbawa na ang default din.

Ang mga parameter ng Slash's API ay maaaring magmukhang ganito para sa pagkuha ng mga bola:

GET

Hakbang 6: I-format ang Iyong Kahilingan

Nakuha namin ang lahat ng impormasyong kailangan namin, ngayon kailangan lang naming maghiling!

Narito ang dalawang magkakaibang paraan upang kumonekta sa isang API na nangangailangan ng walang code. Kumonekta tayo sa Slash's API upang makuha ang kanyang listahan ng mga bola sa pamamagitan ng paggawa ng isang kahilingan na GET sa

Parabola - kung nais mong kumonekta at magtrabaho kasama ang data nang walang code

Ang Parabola ay isang web app na nagbibigay-daan sa iyo upang madaling kumonekta sa mga API at pagkatapos ay gumana kasama ang data sa pamamagitan ng isang visual, drag-and-drop na tool.