Yhdistä sovellusliittymiin ilman koodia: 8 vaihetta

2024 Kirjoittaja: John Day | [email protected]. Viimeksi muokattu: 2024-01-30 09:00

Tämä opas on tarkoitettu ihmisille, joilla on jotain, mitä he haluavat saavuttaa ja jotka edellyttävät sovellusliittymän käyttöä, mutta eivät ole varma, miten pääset alkuun. Tiedät jo, miksi sovellusliittymän kanssa työskentely on hyödyllistä, ja tämä opas näyttää sinulle, miten se tehdään.

Jos se kuulostaa sinulta, olet onnekas! Olemme täällä selittääksemme, kuinka työskennellä sovellusliittymien kanssa, kuinka lukea API -asiakirjoja ja miten todella käyttää API: sta tulevia tietoja.

Otimme ystävän mukaan, jotta matka olisi paljon helpompaa.

Tapaa Slash

Slash on Michellen ihana, rakastettava koira (kuvassa yllä). Michelle on ohjelmistosuunnittelija, joka rakentaa sovellusliittymiä. Michelle todella nauttii työstään ja on saanut inspiraatiota työnrakentamisen sovellusliittymistä Slash -koulutuksessa.

Kuten ehkä tiedät, sovellusliittymä on kokoelma komentoja, jotka käyttäjä voi antaa verkkopalvelulle, sekä joukko pyyntöä vastaavia vastauksia. Michelle on opettanut Slashin tekemään samoin. Slash on hyvä poika, tuntee erilaisia komentoja ja vastaa aina oikein niin kauan kuin annat hänelle pyynnön, jota hänelle on opetettu. Kun hän innostuu erityisen paljon, hänen häntänsä tulee hulluksi - tätä Michelle ei opettanut API: ille, vaan siksi, että hän on rakastettava pentu ja todella nauttii koulutuksestaan!

Vaihe 1: Päätä, mitä sovellusliittymää tarvitset

Mitä tietoja etsit tai haluat muuttaa?

Yritätkö napata kaikki @dougthepugin Instagram -viestit? Ehkä haluat twiittaa automaattisesti jokaiselle, joka seuraa koirasi twitteriä (koska vaikka koirat eivät voi puhua, heillä on paljon sanottavaa, tiedämme, että Slash varmasti tekee).

Jos tiedät jo sivuston tai sovellusliittymän, johon yrität muodostaa yhteyden, siirry suoraan vaiheeseen 2. Jos yrität löytää tietoja, mutta et ole varma mistä aloittaa, Google on ystäväsi. Hae "[sinua kiinnostava juttu] -sovellusliittymä" ja katso, mitä tulee esiin. Saatat yllättyä siitä, kuinka paljon tietoa on saatavilla.

Jos haluat yksinkertaisen esimerkkisovellusliittymän, voit käyttää sitä Michelleä, joka on tehty Slash -koulutuksen aikana. Siinä on joitain hänen suosikkikomentojaan, kuten pallojen nouto ja reikien kaivaminen. Käytämme sitä kaikissa muissa esimerkeissämme.

Vaihe 2: Etsi sovellusliittymäasiakirjat

Tunnettujen yritysten tarjoamilla sovellusliittymillä tulee olla perusteellinen dokumentaatio niiden käytöstä.

Löytääksesi nämä, google "[Insert Company] -sovellusliittymän dokumentaatio" tai "[Insert Company] -kehittäjä".

Tulosten pitäisi viedä sinut kehittäjäportaaliin. Etsi linkki, jossa lukee "Docs", "Documentation", "Reference" tai "Technical Reference".

Asiakirjoista saatat joutua etsimään haluamasi sovellusliittymän, koska joskus vaihtoehtoja voi olla monia. Esimerkiksi Facebookilla on erilliset sovellusliittymät markkinointia, mainoksia, sivuja ja paljon muuta varten.

Jos sovellusliittymä, johon haluat muodostaa yhteyden, ei ole tunnettu (kuten Slash), sinun on ehkä pyydettävä dokumentaatiota kehittäjältä. Heillä voi olla PDF -tiedosto, joka sisältää tarvitsemasi tiedot, tai online -asiakirjat, joita ei ole lueteltu heidän verkkosivuillaan.

Jos unohdit linkin edellisessä vaiheessa, Slashin sovellusliittymän asiakirjat löytyvät täältä.

Vaihe 3: Etsi päätepiste

API -asiakirjat voivat näyttää pelottavilta, mutta kun tiedät mitä etsiä, ne ovat yleensä hyvin jäsenneltyjä ja melko standardoituja.

Ensimmäinen asia, joka on etsittävä, on sopivat päätepisteet. Kutakin tietotyyppiä vastaavaa päätepistettä pitäisi olla yksi. Päätepiste voisi näyttää tältä:

slashtheapidog.com/api/bones/{id}

tai vain

/luut

Dokumentaatiossa on oltava luettelo päätepisteistä. Ne voivat olla asiakirjojen huipputasoa tai "viite", "päätepisteet" tai "menetelmät" -osiossa. Löytääksesi oikean päätepisteen, etsi nimi, joka vastaa etsimääsi dataa. Jos esimerkiksi haluat luettelon kaikista Slashin kaivamista rei'istä, /reikä on luultavasti oikea. Joka tapauksessa jokaisella päätepisteellä on oltava kuvaus, joka auttaa selittämään, mitä se tekee.

Hänen asiakirjoistaan nämä ovat Slashin sovellusliittymän päätepisteet, jotka liittyvät reikiin:

HANKI

HANKI

Julkaise

LAITA

Julkaise

Vaihe 4: Määritä pyyntötyyppi

Nyt kun olet löytänyt oikean päätepisteen, sinun on määritettävä sen lähettämisen pyyntö.

Pyyntöjä on 4 eri tyyppiä:

SAADA

GET -pyyntö on se, miten pyydät sovellusliittymää vastaamaan jollakin sillä olevilla tiedoilla, useimmiten tiedoilla. Voit pyytää erityisiä tietoja yhdestä tuotteesta tai kohderyhmästä päätepisteen ja parametrien perusteella. Tämä vastaa Slashin pyytämistä tuomaan sinulle yksi hänen luistaan tai kaikki hänen luunsa.

LÄHETTÄÄ

POST -pyyntö on se, miten kehotat sovellusliittymää luomaan jotain uutta. Tämä on samanlaista kuin pyytää Slashia kaivamaan (luomaan) sinulle uusi reikä.

LAITTAA

PUT -pyyntö on se, miten kehotat sovellusliittymää päivittämään aiemmin luodun. Tämä on samanlaista kuin pyytää Slashia kaivamaan syvemmälle (päivittämään) kaivamaansa reikään.

POISTAA

DELETE -pyyntö on se, miten kehotat sovellusliittymää poistamaan aiemmin luodun. Tämä on samanlaista kuin pyytää Slashia peittämään (poistamaan) aiemmin kaivamansa aukko.

Ajattele näitä neljää tyyppiä. Saako tietoja, luodaanko uusi merkintä, muutetaanko olemassa olevaa vai poistetaanko se? Tämä vastaus kertoo tarkalleen, minkä tyyppistä pyyntöä tarvitset.

Vaihe 5: Ymmärrä parametrit

Monet pyynnöt vaativat lisäparametreja. Parametrit ovat pyyntösi tiedot. Jos haluat esimerkiksi, että Slash tuo sinulle kaikki punaiset pallot, sinun on määritettävä väri. Jos haluat, että hän luo uuden reiän, sinun on kerrottava hänelle, mihin se laitetaan ja kuinka syvälle kaivaa.

Viittaamasi sovellusliittymän dokumentaatiossa pitäisi olla osio "Parameters" tai "Options" kullekin päätepisteelle ja pyyntötyypille. Kiinnitä huomiota tarvittaviin parametreihin, koska jotkut ovat valinnaisia. Jos parametri on merkitty valinnaiseksi, asiakirjat voivat tarjota esimerkin, joka on myös oletusarvo.

Slashin sovellusliittymän parametrit saattavat näyttää tältä pallojen noutamisessa:

HANKI

Vaihe 6: Muotoile pyyntösi

Meillä on kaikki tarvitsemamme tiedot, nyt meidän on vain tehtävä pyyntö!

Tässä on kaksi eri tapaa muodostaa yhteys sovellusliittymään, jotka eivät vaadi koodia. Yhdistämme Slashin sovellusliittymän saadaksemme hänen palloluettelonsa tekemällä GET -pyynnön osoitteeseen

Parabola - jos haluat muodostaa yhteyden ja käsitellä tietoja ilman koodia

Parabola on verkkosovellus, jonka avulla voit helposti muodostaa yhteyden sovellusliittymiin ja käsitellä sitten tietoja visuaalisen vedä ja pudota -työkalun avulla.