Ühendage ilma koodita API -dega: 8 sammu

2024 Autor: John Day | [email protected]. Viimati modifitseeritud: 2024-01-30 08:46

See juhend on mõeldud inimestele, kellel on midagi, mida nad tahavad saavutada ja mis nõuavad API kasutamist, kuid pole päris kindlad, kuidas alustada. Te teate juba, miks API -ga töötamine on kasulik, ja see juhend näitab teile, kuidas seda teha.

Kui see kõlab nagu sina, on sul õnne! Oleme siin, et selgitada, kuidas töötada API -dega, kuidas lugeda API -dokumente ja kuidas tegelikult API -lt tagasitulevaid andmeid kasutada.

Võtsime sõbra kaasa, et reisi palju lihtsamaks teha.

Tutvuge Slashiga

Slash on Michelle'i jumalik, armastusväärne koer (pildil ülal). Michelle on tarkvarainsener, kes ehitab API -sid. Michelle naudib oma tööd väga ja on Slashi koolitamisel inspiratsiooni ammutanud oma tööde koostamise API -dest.

Nagu te ehk teate, on API käskude kogum, mille kasutaja saab veebiteenusele anda koos taotlusele vastavate vastuste kogumiga. Michelle on koolitanud Slashi sama tegema. Slash on hea poiss, teab erinevaid käske ja vastab alati õigesti, kui esitate talle taotluse, mida talle on õpetatud. Kui ta erutub, läheb saba hulluks - see pole midagi, mida Michelle talle API -dega õpetas, see on lihtsalt sellepärast, et ta on armastusväärne kutsikas ja naudib oma koolitust väga!

Samm: otsustage, millist API -d vajate

Millist teavet otsite või soovite muuta?

Kas proovite haarata kõik @dougthepug Instagrami postitused? Võib -olla soovite automaatselt säutsuda igaühele, kes teie koera twitterit jälgib (sest kuigi koerad ei oska rääkida, on neil palju öelda, me teame, et Slash seda kindlasti teeb).

Kui teate juba saiti või API -d, millega proovite ühendust luua, minge otse 2. sammu juurde. Kui proovite andmeid leida, kuid pole kindel, kust alustada, on Google teie sõber. Otsige "[asjad, mis teid huvitavad] API" ja vaadake, mis ilmub. Võite olla üllatunud, kui palju teavet on olemas.

Kui soovite lihtsat API -näidet, võite kasutada seda Michelle'i, mis on tehtud Slashi koolituse ajal. Sellel on mõned tema lemmikkäsklused, nagu pallide otsimine ja aukude kaevamine. Me kasutame seda ülejäänud näidetes.

2. toiming: leidke API -dokumendid

Tuntud ettevõtete pakutavatel API-del peaks olema põhjalik dokumentatsioon nende kasutamise kohta.

Nende leidmiseks google "[Insert Company] API dokumentatsioon" või "[Insert Company] arendaja".

Tulemused peaksid viima teid arendajaportaali. Otsige linki „Dokumendid”, „Dokumentatsioon”, „Viide” või „Tehniline viide”.

Dokumentides peate võib -olla otsima soovitud API -d, kuna mõnikord võib olla palju valikuid. Näiteks Facebookil on eraldi API -d turunduse, reklaamide, lehtede ja muu jaoks.

Kui API, millega soovite ühenduse luua, pole hästi teada (näiteks Slashi oma), peate võib -olla küsima arendajalt dokumente. Neil võib olla PDF, mis sisaldab vajalikku teavet, või veebidokumentatsioon, mida nende veebisaidil pole.

Kui jäite eelmises etapis lingist ilma, leiate Slashi API -dokumendid siit.

Samm: leidke lõpp -punkt

API -dokumendid võivad tunduda hirmutavad, kuid kui teate, mida otsida, on need tavaliselt hästi struktureeritud ja üsna standardiseeritud.

Esimene asi, mida otsida, on sobivad lõpp -punktid. Igale soovitud andmetüübile peaks vastama üks lõpp -punkt. Lõpptulemus võiks välja näha selline:

slashtheapidog.com/api/bones/{id}

või lihtsalt

/luud

Dokumentatsioonil peaks olema lõpp -punktide loend. Need võivad olla dokumentides tipptasemel või jaotises „viide”, „lõpp -punktid” või „meetodid”. Õige lõpp -punkti leidmiseks otsige otsitavatele andmetele vastavat nime. Näiteks kui soovite nimekirja kõikidest aukudest, mille Slash on kaevanud, on /augud tõenäoliselt õige. Igal juhul peaks igal lõpp -punktil olema kirjeldus, mis aitab selgitada, mida see teeb.

Tema dokumentide järgi on need Slashi API lõpp -punktid, mis on seotud aukudega:

Hangi

Hangi

POSTITA

PANGE

POSTITA

Samm: määrake oma taotluse tüüp

Nüüd, kui olete leidnud õige lõpp -punkti, peate määrama selle saatmise päringu tüübi.

Taotlusi on 4 erinevat tüüpi:

GET

GET -päring on see, kuidas palute API -l vastata midagi, mis tal on, enamasti andmed. Lõpp -punkti ja parameetrite alusel saate küsida konkreetset teavet ühe üksuse või üksuste rühma kohta. See on samaväärne palumisega Slashil tuua teile üks tema luudest või kõik tema luud.

POSTITA

POST -päring on see, kuidas käskite API -l midagi uut luua. See on sarnane palumisega Slashil teie jaoks uus auk kaevata (luua).

PUT

PUT -taotlus on see, kuidas käskite API -l värskendada midagi, mis oli varem loodud. See sarnaneb palvega, et Slash kaevuks tema kaevatud auku sügavamale (uuenda).

KUSTUTA

Kustutamistaotlus on see, kuidas käskite API -l kustutada midagi, mis oli varem loodud. See on sarnane palumisega Slashil varjata (kustutada) auk, mille ta varem kaevas.

Mõelge neile neljale tüübile. Kas saate teavet, loote uue kirje, muudate olemasolevat või kustutate selle? See vastus ütleb teile täpselt, millist päringutüüpi vajate.

Samm: mõistke parameetreid

Paljud taotlused nõuavad täiendavaid parameetreid. Parameetrid on teie päringu üksikasjad. Näiteks kui soovite, et Slash tooks teile kõik punased pallid, peate määrama värvi. Kui soovite, et ta looks uue augu, peate talle ütlema, kuhu see panna ja kui sügavale kaevama.

Viidatud API dokumentatsioonil peaks olema iga lõpp -punkti ja päringuliigi jaoks jaotis „Parameetrid” või „Valikud”. Pöörake tähelepanu vajalikele parameetritele, kuna mõned neist on valikulised. Kui parameeter on märgitud valikuliseks, võivad dokumendid tuua näite, mis on ka vaikimisi.

Slashi API parameetrid võivad pallide hankimisel välja näha umbes sellised:

Hangi

6. samm: vormistage oma taotlus

Meil on kogu vajalik teave, nüüd peame lihtsalt taotluse esitama!

Siin on kaks erinevat võimalust API -ga ühenduse loomiseks, mis ei vaja koodi. Loome ühenduse Slashi API -ga, et saada tema pallide loend, esitades GET -päringu aadressile

Parabool - kui soovite luua ühenduse ilma koodita ja nendega töötada

Parabola on veebirakendus, mis võimaldab hõlpsasti API-dega ühenduse luua ja seejärel andmetega töötada visuaalse pukseerimistööriista kaudu.