Koppel aan API's sonder kode: 8 stappe

2024 Outeur: John Day | [email protected]. Laas verander: 2024-01-30 07:24

Hierdie gids is ontwerp vir mense wat iets wil bereik wat 'n API benodig, maar nie heeltemal weet hoe om te begin nie. U weet reeds waarom dit nuttig is om met 'n API te kan werk, en hierdie gids sal u wys hoe u dit moet doen.

As dit vir jou klink, het jy geluk! Ons is hier om te verduidelik hoe u met API's moet werk, hoe u API -dokumente moet lees en hoe u die data wat uit 'n API terugkom, eintlik kan gebruik.

Ons het 'n vriend saamgebring om die reis baie makliker te maak.

Ontmoet Slash

Slash is Michelle se pragtige, lieflike hond (foto hierbo). Michelle is 'n sagteware -ingenieur wat API's bou. Michelle geniet haar werk baie en het inspirasie gekry uit haar werk om API's te bou vir die opleiding van Slash.

Soos u dalk weet, is 'n API 'n versameling opdragte wat 'n gebruiker aan 'n webdiens kan gee, saam met 'n stel antwoorde wat by die versoek pas. Michelle het Slash opgelei om presies dieselfde te doen. Slash is 'n goeie seun, ken 'n verskeidenheid opdragte en reageer altyd korrek, solank jy hom 'n versoek gee wat hom geleer is. As hy ekstra opgewonde raak, word sy stert mal - dit is nie iets wat Michelle hom geleer het met betrekking tot API's nie, dit is net omdat hy 'n liefdevolle hondjie is en sy opleiding baie geniet!

Stap 1: Besluit watter API u benodig

Watter inligting soek u of wil u dit verander?

Probeer u al die Instagram -plasings van @dougthepug gryp? Miskien wil u outomaties tweet vir almal wat die hond se twitter volg (want alhoewel honde nie kan praat nie, het hulle baie om te sê, maar ons weet Slash wel).

As u reeds die webwerf of API ken waarmee u probeer koppel, gaan dan direk na stap 2. As u data soek, maar nie seker is waar om te begin nie, is Google u vriend. Soek na die API

As u 'n eenvoudige voorbeeld -API wil hê, kan u die een wat Michelle gemaak het, gebruik tydens die opleiding van Slash. Dit het 'n paar van sy gunsteling opdragte, soos om balle te haal en gate te grawe. Ons sal dit in die res van ons voorbeelde gebruik.

Stap 2: Soek die API -dokumente

API's wat deur bekende ondernemings verskaf word, moet deeglike dokumentasie hê oor hoe om dit te gebruik.

Om dit te vind, google "[Insert Company] API -dokumentasie" of "[Insert Company] ontwikkelaar".

Die resultate moet u na die ontwikkelaarportaal neem. Soek 'n skakel wat sê "Dokumente", "Dokumentasie", "Verwysing" of "Tegniese verwysing".

Binne die dokumente moet u moontlik soek na die spesifieke API wat u wil hê, aangesien daar soms baie opsies kan wees. Facebook het byvoorbeeld afsonderlike API's vir bemarking, advertensies, bladsye en meer.

As die API waarmee u wil koppel nie bekend is nie (soos Slash), moet u moontlik die ontwikkelaar om dokumentasie vra. Hulle het moontlik 'n PDF met die inligting wat u benodig, of aanlyn dokumentasie wat nie op hul webwerf verskyn nie.

As u die skakel in die vorige stap gemis het, kan die API -dokumente van Slash hier gevind word.

Stap 3: Soek die eindpunt

API -dokumente lyk dalk skrikwekkend, maar sodra u weet wat u moet soek, is dit gewoonlik goed gestruktureerd en redelik gestandaardiseerd.

Die eerste ding om na te kyk, is die gepaste eindpunt (e). Daar moet een eindpunt wees wat ooreenstem met elke tipe data wat u wil hê. 'N Eindpunt kan so lyk:

slashtheapidog.com/api/bones/{id}

of net

/bene

Die dokumentasie moet 'n lys eindpunte bevat. Hulle kan op die hoogste vlak in die dokumente wees of onder 'n afdeling genaamd 'verwysing', 'eindpunte' of 'metodes'. Om die regte eindpunt te vind, soek die naam wat ooreenstem met die data wat u soek. As u byvoorbeeld 'n lys wil hê van al die gate wat Slash gegrawe het, is /is die gate waarskynlik die regte een. Elke eindpunt moet in elk geval 'n beskrywing hê om te verduidelik wat dit doen.

Uit sy dokumente is dit die eindpunte in Slash se API wat verband hou met gate:

KRY

KRY

POST

PUT

POST

Stap 4: Bepaal u versoekstipe

Noudat u die regte eindpunt gevind het, moet u die tipe versoek bepaal om dit te stuur.

Daar is 4 verskillende tipes versoeke:

KRY

'N GET -versoek is hoe u die API vra om te reageer met iets wat dit bevat, meestal data. U kan spesifieke inligting oor een item of 'n groep items vra op grond van die eindpunt en parameters. Dit is die ekwivalent om Slash te vra om een van sy bene of al sy bene vir u te bring.

POST

'N POST -versoek is hoe u die API vertel om iets nuuts te skep. Dit is soortgelyk aan om Slash te vra om 'n nuwe gat vir u te grawe (skep).

PUT

'N PUT -versoek is hoe u die API vertel om iets wat voorheen geskep is, op te dateer. Dit is soortgelyk aan om Slash te vra om dieper in die gat te grawe wat hy gegrawe het.

SKRYF

'N VERWYSER -versoek is hoe u die API vertel om iets wat voorheen geskep is, uit te vee. Dit is soortgelyk aan om Slash te vra om 'n gat wat hy voorheen gegrawe het, toe te maak (te verwyder).

Dink aan hierdie vier tipes. Kry u inligting, skep u 'n nuwe inskrywing, verander u 'n bestaande inskrywing of verwyder u dit? Die antwoord sê presies watter tipe versoek u benodig.

Stap 5: Verstaan die parameters

Baie versoeke vereis addisionele parameters. Parameters is die besonderhede van u versoek. As u byvoorbeeld wil hê dat Slash al die rooi balle vir u moet bring, moet u die kleur spesifiseer. As jy wil hê dat hy 'n nuwe gat moet skep, moet jy hom vertel waar hy dit moet plaas en hoe diep hy moet grawe.

Die API -dokumentasie waarna u verwys, moet 'n afdeling met die naam "Parameters" of "Opsies" bevat vir elke eindpunt en tipe versoek. Let op watter parameters benodig word, aangesien sommige opsioneel is. As 'n parameter as opsioneel gemerk is, kan die dokumente 'n voorbeeld verskaf wat ook die standaard is.

Die API -parameters van Slash kan so lyk om balle te haal:

KRY

Stap 6: Formateer u versoek

Ons het al die inligting wat ons nodig het, nou hoef ons net die versoek te rig!

Hier is twee verskillende maniere om aan te sluit op 'n API wat geen kode benodig nie. Kom ons skakel by die API van Slash om sy lys balle te kry deur 'n GET -versoek te rig na

Parabool - as u wil verbind met data en sonder kode wil werk

Parabola is 'n webprogram waarmee u maklik met API's kan koppel en dan met die data kan werk deur middel van 'n visuele, sleep-en-neerslag-instrument.