Lidhu me API -të pa kod: 8 hapa

2024 Autor: John Day | [email protected]. E modifikuara e fundit: 2024-01-30 12:11

Ky udhëzues është krijuar për njerëzit që kanë diçka që duan të arrijnë që kërkon përdorimin e një API, por nuk janë plotësisht të sigurt se si të fillojnë. Ju tashmë e dini pse të qenit në gjendje të punoni me një API është e dobishme, dhe ky udhëzues do t'ju tregojë se si ta bëni këtë.

Nëse kjo tingëllon si ju, keni fat! Ne jemi këtu për të shpjeguar se si të punojmë me API, si të lexojmë dokumentet API dhe si të përdorim në të vërtetë të dhënat që vijnë nga një API.

Ne kemi sjellë një mik për ta bërë udhëtimin shumë më të lehtë.

Njihuni me Slash

Slash është qeni i mrekullueshëm dhe i dashur i Michelle (foto më lart). Michelle është një inxhinier softuerësh që ndërton API. Michelle me të vërtetë gëzon punën e saj dhe ka marrë frymëzim nga API -të e saj të punës në stërvitjen e Slash.

Siç mund ta dini, një API është një koleksion komandash që një përdorues mund t'i japë një shërbimi në internet së bashku me një grup përgjigjesh që përputhen me kërkesën. Michelle e ka trajnuar Slashin të bëjë të njëjtën gjë. Slash është një djalë i mirë, di një sërë komandash dhe gjithmonë përgjigjet saktë për sa kohë që i bëni një kërkesë që i është mësuar. Kur ai emocionohet shumë, bishti i tij çmendet - kjo nuk është diçka që Michelle e mësoi në lidhje me API -të, është vetëm sepse ai është një qenush i dashur dhe i pëlqen vërtet stërvitja e tij!

Hapi 1: Vendosni se çfarë API ju nevojitet

Çfarë informacioni po kërkoni ose doni të ndryshoni?

Po përpiqeni të kapni të gjitha postimet e @dougthepug në Instagram? Ndoshta ju doni të cicëroni automatikisht këdo që ndjek twitterin e qenit tuaj (sepse edhe pse qentë nuk mund të flasin, ata kanë shumë për të thënë, ne e dimë që Slash sigurisht që flet).

Nëse e njihni tashmë sitin ose API me të cilin po përpiqeni të lidheni, shkoni direkt në Hapin 2. Nëse po përpiqeni të gjeni të dhëna, por nuk jeni të sigurt se ku të filloni, Google është miku juaj. Kërkoni për "[gjërat që ju interesojnë] API" dhe shikoni se çfarë del. Ju mund të habiteni se sa informacion ka atje.

Nëse dëshironi një API shembull të thjeshtë, mund të përdorni atë që Michelle bëri gjatë stërvitjes së Slash. Ka disa nga komandat e tij të preferuara si marrja e topave dhe gërmimi i vrimave. Ne do ta përdorim atë në pjesën tjetër të shembujve tanë.

Hapi 2: Gjeni Dokumentet API

API-të e ofruara nga kompani të njohura duhet të kenë dokumentacion të plotë se si t'i përdorin ato.

Për t'i gjetur këto, google "[Insert Company] dokumentacionin API" ose "[Insert Company] developer".

Rezultatet duhet t'ju çojnë në portalin e zhvilluesve. Shikoni për një lidhje që thotë "Docs", "Documentation", "Reference" ose "Referenca Teknike".

Brenda dokumenteve, mund t'ju duhet të kërkoni API -në specifike që dëshironi pasi ndonjëherë mund të ketë shumë mundësi. Facebook, për shembull, ka API të veçantë për marketing, reklama, faqe dhe më shumë.

Nëse API -ja me të cilën dëshironi të lidheni nuk është e njohur (si ajo e Slash), mund t'ju duhet të pyesni zhvilluesin për dokumentacion. Ata mund të kenë një PDF që përmban informacionin që ju nevojitet ose dokumentacion online që nuk është i shënuar në faqen e tyre të internetit.

Nëse keni humbur lidhjen në hapin e mëparshëm, dokumentet API të Slash mund të gjenden këtu.

Hapi 3: Gjeni pikën përfundimtare

Dokumentet API mund të duken të frikshme, por pasi të dini se çfarë të kërkoni, ato zakonisht janë të strukturuara mirë dhe mjaft të standardizuara.

Gjëja e parë që duhet kërkuar është pika (t) përfundimtare e përshtatshme. Duhet të ketë një pikë përfundimtare që korrespondon me secilin lloj të dhënash që dëshironi. Një pikë përfundimtare mund të duket kështu:

slashtheapidog.com/api/bones/{id}

ose thjesht

/kockat

Dokumentacioni duhet të ketë një listë të pikave përfundimtare. Ato mund të jenë të nivelit të lartë në dokumente ose nën një seksion të quajtur "referencë", "pika përfundimtare" ose "metoda". Për të gjetur pikën përfundimtare të duhur, kërkoni emrin që korrespondon me të dhënat që kërkoni. Për shembull, nëse doni një listë të të gjitha vrimave që Slash ka hapur, /vrimat është ndoshta ajo e duhura. Në çdo rast, çdo pikë përfundimtare duhet të ketë një përshkrim për të ndihmuar në shpjegimin e asaj që bën.

Nga dokumentet e tij, këto janë pikat përfundimtare në API të Slash në lidhje me vrimat:

MERRNI

MERRNI

POST

Vendoseni

POST

Hapi 4: Përcaktoni llojin e kërkesës tuaj

Tani që keni gjetur pikën përfundimtare të duhur, duhet të përcaktoni llojin e kërkesës për ta dërguar atë.

Ekzistojnë 4 lloje të ndryshme kërkesash:

MARR

Një kërkesë GET është se si i kërkoni API -së të përgjigjet me diçka që ka, më shpesh të dhëna. Ju mund të kërkoni informacion specifik në lidhje me një artikull ose një grup artikujsh bazuar në pikën përfundimtare dhe parametrat. Kjo është e barabartë me pyetjen e Slash për t'ju sjellë një nga kockat e tij ose të gjitha kockat e tij.

POST

Një kërkesë POST është se si i thoni API -së të krijojë diçka të re. Kjo është e ngjashme me pyetjen e Slash për të gërmuar (krijuar) një vrimë të re për ju.

SHTYP

Një kërkesë PUT është se si i thoni API -së të azhurnojë diçka që është krijuar më parë. Kjo është e ngjashme me pyetjen e Slash për të gërmuar më thellë (përditësuar) në vrimën që ai gërmoi.

FSHIJ

Një kërkesë FSHIJ është se si i thoni API -së të fshijë diçka që është krijuar më parë. Kjo është e ngjashme me pyetjen e Slash për të mbuluar (fshirë) një vrimë që ai kishte hapur më parë.

Mendoni për këto katër lloje. A po merrni informacion, krijoni një hyrje të re, ndryshoni një hyrje ekzistuese ose fshini një? Kjo përgjigje ju tregon saktësisht se çfarë lloj kërkese ju nevojitet.

Hapi 5: Kuptoni Parametrat

Shumë kërkesa kërkojnë parametra shtesë. Parametrat janë detajet e kërkesës suaj. Për shembull, nëse doni që Slash t'ju sjellë të gjitha topat që janë të kuq, duhet të specifikoni ngjyrën. Nëse dëshironi që ai të krijojë një vrimë të re, duhet t'i tregoni se ku ta vendosni dhe sa thellë të gërmoni.

Dokumentacioni API të cilit po i referoheni duhet të ketë një seksion të quajtur "Parametrat" ose "Opsionet" për secilën pikë përfundimtare dhe lloj kërkese. Kushtojini vëmendje parametrave që kërkohen pasi disa janë opsionale. Nëse një parametër shënohet si opsional, dokumentet mund të japin një shembull që është gjithashtu i paracaktuar.

Parametrat API të Slash mund të duken diçka si kjo për marrjen e topave:

MERRNI

Hapi 6: Formatoni kërkesën tuaj

Ne kemi të gjithë informacionin që na nevojitet, tani na mbetet vetëm të bëjmë kërkesën!

Këtu janë dy mënyra të ndryshme për t'u lidhur me një API që nuk kërkojnë kod. Le të lidhemi me API të Slash për të marrë listën e tij të topave duke bërë një kërkesë GET në

Parabola - nëse doni të lidheni dhe të punoni me të dhëna pa kod

Parabola është një aplikacion në internet që ju lejon të lidheni lehtësisht me API dhe më pas të punoni me të dhënat përmes një mjeti vizual, tërheqës dhe lëshues.