Kazalo:
- 1. korak: Odločite se, kateri API potrebujete
- 2. korak: Poiščite Dokumente API
- 3. korak: Poiščite končno točko
- 4. korak: Določite vrsto zahteve
- 5. korak: Razumeti parametre
- 6. korak: Formatirajte svojo zahtevo
Video: Povežite se z API -ji brez kode: 8 korakov
2024 Avtor: John Day | [email protected]. Nazadnje spremenjeno: 2024-01-30 12:03
Ta priročnik je namenjen ljudem, ki želijo doseči nekaj, kar zahteva uporabo API -ja, vendar niso prepričani, kako začeti. Že veste, zakaj je delo z API -jem koristno, in ta priročnik vam bo pokazal, kako to storiti.
Če se sliši kot ti, imaš srečo! Tukaj smo, da razložimo, kako delati z API -ji, kako brati dokumente API -ja in kako dejansko uporabiti podatke, ki prihajajo iz API -ja.
S seboj smo pripeljali prijatelja, ki bo olajšal potovanje.
Spoznajte Slash
Slash je Michellein čudovit, ljubek pes (na sliki zgoraj). Michelle je inženirka programske opreme, ki gradi API -je. Michelle zelo uživa v svojem delu in se je pri usposabljanju za Slash navdihnila pri ustvarjanju API -jev za delo.
Kot morda veste, je API zbirka ukazov, ki jih lahko uporabnik poda spletni storitvi, skupaj z nizom odgovorov, ki ustrezajo zahtevi. Michelle je za isto naredila Slash. Slash je dober fant, pozna različne ukaze in se vedno pravilno odzove, dokler mu daš prošnjo, ki so jo naučili. Ko se še bolj razveseli, mu rep zmeša - tega ga Michelle ni naučila v zvezi z API -ji, to je samo zato, ker je ljubek mladič in res uživa v svojem treningu!
1. korak: Odločite se, kateri API potrebujete
Katere podatke iščete ali želite spremeniti?
Ali poskušate zajeti vse objave na Instagramu @dougthepug? Morda želite samodejno tvitati vsakogar, ki spremlja twitter vašega psa (ker čeprav psi ne morejo govoriti, imajo veliko povedati, saj Slash zagotovo ve).
Če že poznate spletno mesto ali API, s katerim se želite povezati, pojdite neposredno na 2. korak. Če poskušate najti podatke, vendar niste prepričani, kje začeti, je Google vaš prijatelj. Poiščite "[stvari, ki vas zanimajo] API" in poglejte, kaj se bo pojavilo. Morda boste presenečeni, koliko informacij je na voljo.
Če želite preprost primer API -ja, lahko uporabite tistega, ki ga je izdelala Michelle med usposabljanjem Slash. Ima nekaj njegovih najljubših ukazov, kot so pridobivanje kroglic in kopanje lukenj. Uporabljali ga bomo v preostalih primerih.
2. korak: Poiščite Dokumente API
API-ji, ki jih ponujajo znana podjetja, morajo imeti temeljito dokumentacijo o njihovi uporabi.
Če jih želite poiskati, poiščite google "[Insert Company] API documentation" ali "[Insert Company] razvijalec".
Rezultati bi vas morali odpeljati na portal za razvijalce. Poiščite povezavo, ki pravi "Dokumenti", "Dokumentacija", "Referenca" ali "Tehnična referenca".
V dokumentih boste morda morali poiskati poseben API, ki ga želite, saj je včasih lahko veliko možnosti. Facebook ima na primer ločene API -je za trženje, oglase, strani in drugo.
Če API, s katerim se želite povezati, ni dobro znan (na primer Slash -ov), boste morda morali razvijalca zaprositi za dokumentacijo. Morda imajo PDF, ki vsebuje potrebne informacije, ali spletno dokumentacijo, ki ni navedena na njihovi spletni strani.
Če ste v prejšnjem koraku zamudili povezavo, lahko dokumente Slash -ovega API -ja najdete tukaj.
3. korak: Poiščite končno točko
Dokumenti API lahko izgledajo zastrašujoče, a ko veste, kaj iskati, so običajno dobro strukturirani in precej standardizirani.
Prva stvar, ki jo je treba iskati, so ustrezne končne točke. Za vsako vrsto podatkov, ki jih želite, mora biti ena končna točka. Končna točka bi lahko izgledala tako:
slashtheapidog.com/api/bones/{id}
ali samo
/kosti
Dokumentacija mora imeti seznam končnih točk. Lahko so na najvišji ravni v dokumentih ali v razdelku, imenovanem "referenca", "končne točke" ali "metode". Če želite najti pravo končno točko, poiščite ime, ki ustreza podatkom, ki jih iščete. Na primer, če želite seznam vseh lukenj, ki jih je Slash izkopal, je /luknje verjetno prava. Vsekakor mora imeti vsaka končna točka opis, ki bo pomagal pojasniti, kaj počne.
Iz njegovih dokumentov so to končne točke v API -ju Slash, povezane z luknjami:
PREJMI
PREJMI
OBJAVA
POSTAVITE
4. korak: Določite vrsto zahteve
Zdaj, ko ste našli pravo končno točko, morate določiti vrsto zahteve za njeno pošiljanje.
Obstajajo 4 različne vrste zahtev:
DOBI
Zahteva GET je način, kako od API -ja zahtevate, da se odzove z nečim, kar ima, najpogosteje s podatki. Na podlagi končne točke in parametrov lahko zahtevate posebne informacije o enem elementu ali skupini predmetov. To je enako zahtevi, da Slash prinese eno od njegovih kosti ali vse njegove kosti.
POST
Zahteva POST je, kako poveste API -ju, naj ustvari nekaj novega. To je podobno, kot da Slash zahteva, da vam kopa (ustvari) novo luknjo.
POSTAVI
Zahteva PUT je način, kako API -ju poveste, naj posodobi nekaj, kar je bilo prej ustvarjeno. To je podobno, kot če bi Slash zahteval globlje kopanje (posodobitev) v luknjo, ki jo je izkopal.
IZBRIŠI
Zahteva DELETE je način, kako API -ju poveste, naj izbriše nekaj, kar je bilo prej ustvarjeno. To je podobno, kot da Slash zahteva, da prikrije (izbriše) luknjo, ki jo je prej izkopal.
Pomislite na te štiri vrste. Ali pridobivate informacije, ustvarjate nov vnos, spreminjate obstoječega vnosa ali ga brišete? Ta odgovor natančno pove, kakšno vrsto zahteve potrebujete.
5. korak: Razumeti parametre
Mnoge zahteve zahtevajo dodatne parametre. Parametri so podrobnosti vaše zahteve. Na primer, če želite, da vam Slash prinese vse rdeče kroglice, morate določiti barvo. Če želite, da ustvari novo luknjo, mu morate povedati, kam naj jo postavi in kako globoko jo mora kopati.
Dokumentacija o API -ju, na katero se sklicujete, mora imeti razdelek, imenovan "Parametri" ali "Možnosti", za vsako končno točko in vrsto zahteve. Bodite pozorni, kateri parametri so potrebni, ker so nekateri neobvezni. Če je parameter označen kot neobvezen, lahko dokumenti navedejo primer, ki je tudi privzeti.
Parametri API -ja Slash bi lahko izgledali nekako tako za pridobivanje kroglic:
6. korak: Formatirajte svojo zahtevo
Imamo vse potrebne informacije, zdaj moramo le še vložiti zahtevo!
Tu sta dva različna načina za povezavo z API -jem, ki ne zahtevata kode. Povežimo se s Slash -ovim API -jem, da dobimo njegov seznam žog, tako da zahtevamo GET na
Parabola - če se želite povezati in delati s podatki brez kode
Parabola je spletna aplikacija, ki vam omogoča preprosto povezavo z API-ji in nato delo s podatki prek vizualnega orodja povleci in spusti.
Priporočena:
Naredite EASY Infinity Mirror Cube - Brez 3D tiskanja in brez programiranja: 15 korakov (s slikami)
Naredite EASY Infinity Mirror Cube | Brez 3D tiskanja in brez programiranja: Vsem je všeč dobra neskončna kocka, vendar izgleda, da bi jih bilo težko narediti. Moj cilj te Instructable je, da vam korak za korakom pokažem, kako to narediti. Ne samo to, ampak z navodili, ki vam jih dajem, boste lahko naredili enega od
Nastavitev Raspberry Pi 4 prek prenosnega računalnika/računalnika z uporabo Ethernetnega kabla (brez monitorja, brez Wi-Fi): 8 korakov
Nastavitev Raspberry Pi 4 prek prenosnega računalnika/računalnika z uporabo Ethernetnega kabla (brez monitorja, brez Wi-Fi-ja): Pri tem bomo za nastavitev delali z Raspberry Pi 4 Model-B z 1 Gb RAM-a. Raspberry-Pi je enosmerni računalnik, ki se uporablja za izobraževalne namene in DIY projekte po dostopni ceni, zahteva napajanje 5V 3A
Povežite se z Raspberry Pi v načinu brez glave s telefonom Android Prav tako konfigurirajte WiFi: 5 korakov
Povežite se z Raspberry Pi v načinu brez glave s telefonom Android Prav tako konfigurirajte WiFi: (Uporabljena slika je Raspberry Pi 3 Model B s https://www.raspberrypi.org) Ta navodila vam bodo pokazala, kako povezati Raspberry Pi s telefonom Android, konfigurirati pa morate tudi WiFi na Raspberry Pi v načinu brez glave, tj. brez tipkovnice, miške in zaslona. JAZ
Povežite Raspberry Pi z zaslonom prenosnega računalnika brez kabla LAN ali WIFI: 9 korakov
Povežite Raspberry Pi z zaslonom prenosnika brez kabla LAN ali WIFI: V tej vadnici bom pokazal, kako lahko povežemo Raspberry pi z zaslonom prenosnika brez kabla LAN ali Wi -Fi. Raspberry Pi ima sestavljeno video vtičnico, ki podpira štiri različne načine1. sdtv_mode = 0 Običajni NTSC2. sdtv_mode = 1 jap
Hladilnik / stojalo za prenosni računalnik brez stroškov (brez lepila, brez vrtanja, brez matic in vijakov, brez vijakov): 3 koraki
Hladilnik / stojalo za prenosni računalnik z nič stroški (brez lepila, brez vrtanja, brez matic in vijakov, brez vijakov): UPDATE: PROSIM VELIKO GLASAJ ZA MOJE NAVODILNO, HVALA ^ _ ^ MOGOČE STE ZDRAVILI VPISITE NA www.instructables.com/id/Zero-Cost-Aluminium-Furnace-No-Propane-No-Glue-/ ALI MOŽDA GLASUJTE ZA NAJBOLJŠEGA PRIJATELJA