Izveidojiet savienojumu ar API bez koda: 8 soļi

2024 Autors: John Day | [email protected]. Pēdējoreiz modificēts: 2024-01-30 10:52

Šī rokasgrāmata ir paredzēta cilvēkiem, kuriem ir kaut kas, ko viņi vēlas sasniegt, un kuriem ir jāizmanto API, bet kuri nav īsti pārliecināti, kā sākt darbu. Jūs jau zināt, kāpēc spēja strādāt ar API ir noderīga, un šī rokasgrāmata parādīs, kā to izdarīt.

Ja tas izklausās pēc jums, jums veicas! Mēs esam šeit, lai izskaidrotu, kā strādāt ar API, kā lasīt API dokumentus un kā faktiski izmantot datus, kas nāk no API.

Mēs esam paņēmuši līdzi draugu, lai padarītu ceļojumu daudz vieglāku.

Iepazīstieties ar Slash

Slash ir Mišelas burvīgais, mīļais suns (attēlā iepriekš). Mišela ir programmatūras inženieris, kurš veido API. Mišela patiešām bauda savu darbu un ir iedvesmojusies no sava darba veidošanas API, apmācot Slash.

Kā jūs zināt, API ir komandu kopums, ko lietotājs var dot tīmekļa pakalpojumam, kā arī atbilžu kopa, kas atbilst pieprasījumam. Mišela ir apmācījusi Slashi rīkoties tāpat. Slash ir labs zēns, zina dažādas komandas un vienmēr atbild pareizi, ja vien jūs viņam uzdodat lūgumu, kas viņam ir mācīts. Kad viņš kļūst īpaši satraukts, viņa aste trako - tas nav tas, ko Mišela viņam iemācīja saistībā ar API, tas ir tikai tāpēc, ka viņš ir mīļš kucēns un patiešām bauda savu apmācību!

1. darbība. Izlemiet, kāda API jums nepieciešama

Kādu informāciju jūs meklējat vai vēlaties mainīt?

Vai jūs mēģināt izmantot visas @dougthepug Instagram ziņas? Varbūt jūs vēlaties automātiski tvītot ikvienam, kas seko jūsu suņa twitterim (jo, lai gan suņi neprot runāt, viņiem ir daudz ko teikt, mēs zinām, ka Slash noteikti to dara).

Ja jūs jau zināt vietni vai API, ar kuru mēģināt izveidot savienojumu, pārejiet tieši uz 2. darbību. Ja mēģināt atrast datus, bet neesat pārliecināts, ar ko sākt, Google ir jūsu draugs. Meklējiet “[interesējošās lietas] API” un skatiet, kas parādās. Jūs varētu būt pārsteigts, cik daudz informācijas ir pieejams.

Ja vēlaties vienkāršu API piemēru, varat izmantot Mišelu, kas izveidota Slash apmācības laikā. Tam ir dažas no viņa iecienītākajām komandām, piemēram, bumbiņu izgūšana un bedrīšu rakšana. Mēs to izmantosim pārējos mūsu piemēros.

2. darbība. Atrodiet API dokumentus

API, ko nodrošina labi pazīstami uzņēmumi, jābūt pamatīgai dokumentācijai par to izmantošanu.

Lai tos atrastu, google "[Insert Company] API dokumentācija" vai "[Insert Company] izstrādātājs".

Rezultātiem vajadzētu novirzīt jūs uz izstrādātāju portālu. Meklējiet saiti “Dokumenti”, “Dokumentācija”, “Atsauce” vai “Tehniskā atsauce”.

Dokumentos, iespējams, būs jāmeklē konkrētā API, kuru vēlaties, jo dažreiz var būt daudz iespēju. Piemēram, Facebook ir atsevišķas API mārketingam, reklāmām, lapām un citam.

Ja API, ar kuru vēlaties izveidot savienojumu, nav plaši pazīstama (piemēram, Slash), iespējams, jums būs jālūdz izstrādātājam dokumentācija. Viņiem var būt PDF fails, kas satur nepieciešamo informāciju, vai tiešsaistes dokumentācija, kas nav norādīta viņu vietnē.

Ja esat nokavējis saiti iepriekšējā solī, Slash API dokumentus var atrast šeit.

3. darbība: atrodiet galapunktu

API dokumenti var šķist biedējoši, taču, kad zināt, ko meklēt, tie parasti ir labi strukturēti un diezgan standartizēti.

Pirmā lieta, kas jāmeklē, ir atbilstošais (-ie) galapunkts (-i). Ir jābūt vienam parametram, kas atbilst katram vēlamajam datu veidam. Galapunkts varētu izskatīties šādi:

slashtheapidog.com/api/bones/{id}

vai vienkārši

/kauli

Dokumentācijā jābūt galapunktu sarakstam. Tie var būt augstākā līmeņa dokumentos vai sadaļā “atsauce”, “galapunkti” vai “metodes”. Lai atrastu pareizo galapunktu, meklējiet nosaukumu, kas atbilst jūsu meklētajiem datiem. Piemēram, ja vēlaties visu Slash izrakto bedrīšu sarakstu, /caurumi, iespējams, ir īstais. Jebkurā gadījumā katram parametram jābūt aprakstam, kas palīdzēs izskaidrot, ko tas dara.

No viņa dokumentiem šie ir Slash API galapunkti, kas saistīti ar caurumiem:

IEGŪT

IEGŪT

POST

IELIKT

IZLIKT

4. darbība. Nosakiet pieprasījuma veidu

Tagad, kad esat atradis pareizo galapunktu, jums jānosaka pieprasījuma veids tā nosūtīšanai.

Ir 4 dažādi pieprasījumu veidi:

GŪT

GET pieprasījums ir tas, kā jūs lūdzat API atbildēt ar kaut ko, kas tai ir, visbiežāk datiem. Pamatojoties uz parametru un parametriem, varat lūgt konkrētu informāciju par vienu vienumu vai vienumu grupu. Tas ir līdzvērtīgi lūgumam Slash atnest jums vienu no viņa kauliem vai visus kaulus.

POST

POST pieprasījums ir tas, kā jūs sakāt API izveidot kaut ko jaunu. Tas ir līdzīgi kā lūgums Slash izrakt (izveidot) jums jaunu bedrīti.

PUT

PUT pieprasījums ir tas, kā jūs sakāt API atjaunināt kaut ko iepriekš izveidotu. Tas ir līdzīgi kā lūgums Slasham izrakt dziļāk (atjaunināt) viņa izraktā bedrē.

DZĒST

DELETE pieprasījums ir tas, kā jūs sakāt API dzēst kaut ko iepriekš izveidotu. Tas ir līdzīgi kā lūgums Slasham aizsegt (izdzēst) viņa iepriekš izraktās bedres.

Padomājiet par šiem četriem veidiem. Vai jūs iegūstat informāciju, izveidojat jaunu ierakstu, maināt esošo ierakstu vai dzēšat to? Šī atbilde precīzi norāda, kāds pieprasījuma veids jums ir nepieciešams.

5. darbība: izprotiet parametrus

Daudziem pieprasījumiem ir nepieciešami papildu parametri. Parametri ir informācija par jūsu pieprasījumu. Piemēram, ja vēlaties, lai Slash jums parādītu visas sarkanās bumbiņas, jums jānorāda krāsa. Ja vēlaties, lai viņš izveido jaunu bedri, jums jāpasaka, kur to ievietot un cik dziļi rakt.

API dokumentācijā, uz kuru jūs atsaucaties, ir jābūt sadaļai "Parametri" vai "Opcijas" katram parametram un pieprasījuma veidam. Pievērsiet uzmanību nepieciešamajiem parametriem, jo daži no tiem nav obligāti. Ja parametrs ir atzīmēts kā neobligāts, dokumenti var sniegt piemēru, kas arī ir noklusējuma iestatījums.

Slash API parametri bumbiņu izgūšanai varētu izskatīties šādi:

IEGŪT

6. darbība: formatējiet pieprasījumu

Mums ir visa nepieciešamā informācija, tagad mums tikai jāiesniedz pieprasījums!

Šeit ir divi dažādi veidi, kā izveidot savienojumu ar API, kuriem nav nepieciešams kods. Izveidosim savienojumu ar Slash API, lai iegūtu viņa bumbiņu sarakstu, iesniedzot GET pieprasījumu vietnē

Parabola - ja vēlaties izveidot savienojumu ar datiem un strādāt ar tiem bez koda

Parabola ir tīmekļa lietotne, kas ļauj ērti izveidot savienojumu ar API un pēc tam strādāt ar datiem, izmantojot vizuālu vilkšanas un nomešanas rīku.