Opret forbindelse til API'er uden kode: 8 trin

2024 Forfatter: John Day | [email protected]. Sidst ændret: 2024-01-30 08:26

Denne vejledning er designet til folk, der har noget, de vil opnå, som kræver brug af en API, men ikke er helt sikre på, hvordan de skal komme i gang. Du ved allerede, hvorfor det er nyttigt at kunne arbejde med en API, og denne vejledning viser dig, hvordan du gør det.

Hvis det lyder som dig, har du held og lykke! Vi er her for at forklare, hvordan man arbejder med API'er, hvordan man læser API -dokumenter, og hvordan man rent faktisk kan bruge de data, der kommer tilbage fra en API.

Vi har taget en ven med for at gøre rejsen meget lettere.

Mød Slash

Slash er Michelles yndige, elskelige hund (billedet ovenfor). Michelle er en softwareingeniør, der bygger API'er. Michelle nyder virkelig sit job og har hentet inspiration fra sit arbejde med at bygge API'er i uddannelse af Slash.

Som du måske ved, er en API en samling kommandoer, en bruger kan give til en webtjeneste sammen med et sæt svar, der matcher anmodningen. Michelle har trænet Slash til at gøre det samme. Slash er en god dreng, kender forskellige kommandoer og reagerer altid korrekt, så længe du giver ham en anmodning, som han har lært. Når han bliver ekstra begejstret, bliver hans hale skøre - det er ikke noget Michelle lærte ham i forbindelse med API'er, det er bare fordi han er en elskelig hvalp og virkelig nyder sin træning!

Trin 1: Beslut, hvilken API du har brug for

Hvilken information leder du efter, eller vil du ændre?

Prøver du at få fat i alle @dougthepugs Instagram -indlæg? Måske vil du automatisk tweet til alle, der følger din hunds twitter (for selvom hunde ikke kan tale, har de meget at sige, vi ved, at Slash sikkert gør det).

Hvis du allerede kender det websted eller den API, du prøver at oprette forbindelse til, skal du gå direkte til trin 2. Hvis du forsøger at finde data, men ikke er sikker på, hvor du skal starte, er Google din ven. Søg efter "[ting, du er interesseret i] API", og se, hvad der dukker op. Du vil måske blive overrasket over, hvor meget information der er.

Hvis du gerne vil have et enkelt eksempel -API, kan du bruge den, Michelle lavede, mens du trænede Slash. Det har nogle af hans yndlingskommandoer som at hente bolde og grave huller. Vi vil bruge det i resten af vores eksempler.

Trin 2: Find API -dokumenterne

API'er fra kendte virksomheder bør have grundig dokumentation om, hvordan de bruges.

For at finde disse skal du google "[Insert Company] API -dokumentation" eller "[Insert Company] -udvikler".

Resultaterne skal tage dig til udviklerportalen. Se efter et link, der siger "Docs", "Documentation", "Reference" eller "Technical Reference".

I dokumenterne skal du muligvis kigge efter den specifikke API, du vil have, da der nogle gange kan være mange muligheder. Facebook har for eksempel separate API'er til marketing, annoncer, sider og mere.

Hvis den API, du vil oprette forbindelse til, ikke er kendt (som Slash's), skal du muligvis bede udvikleren om dokumentation. De kan have en PDF -fil, der indeholder de oplysninger, du har brug for, eller online dokumentation, der ikke er angivet på deres websted.

Hvis du gik glip af linket i det foregående trin, kan Slashs API -dokumenter findes her.

Trin 3: Find slutpunktet

API -dokumenter kan se skræmmende ud, men når du ved, hvad du skal kigge efter, er de normalt velstruktureret og temmelig standardiseret.

Den første ting, man skal kigge efter, er det eller de relevante slutpunkter. Der skal være et slutpunkt, der svarer til hver type data, du ønsker. Et endepunkt kan se sådan ud:

slashtheapidog.com/api/bones/{id}

eller bare

/knogler

Dokumentationen skal have en liste over slutpunkter. De kan være på øverste niveau i dokumenterne eller under et afsnit kaldet "reference", "slutpunkter" eller "metoder". For at finde det rigtige slutpunkt skal du kigge efter navnet, der svarer til de data, du leder efter. For eksempel, hvis du vil have en liste over alle de huller Slash har gravet, er /huller sandsynligvis den rigtige. Under alle omstændigheder skal hvert endepunkt have en beskrivelse, der hjælper med at forklare, hvad det gør.

Fra hans dokumenter er disse endepunkterne i Slashs API relateret til huller:

FÅ

HENT

POST

SÆT

POST

Trin 4: Bestem din anmodningstype

Nu hvor du har fundet det rigtige slutpunkt, skal du bestemme typen af anmodning for at sende det.

Der er 4 forskellige typer anmodninger:

FÅ

En GET -anmodning er, hvordan du beder API'en om at reagere med noget, den har, oftest data. Du kan bede om specifikke oplysninger om et element eller en gruppe af elementer baseret på slutpunktet og parametrene. Dette svarer til at bede Slash om at bringe dig en af hans knogler eller alle hans knogler.

STOLPE

En POST -anmodning er, hvordan du fortæller API'en at oprette noget nyt. Dette svarer til at bede Slash om at grave (oprette) et nyt hul til dig.

SÆTTE

En PUT -anmodning er, hvordan du fortæller API'en at opdatere noget, der tidligere blev oprettet. Dette svarer til at bede Slash om at grave dybere (opdatering) i det hul, han gravede.

SLET

En DELETE -anmodning er, hvordan du fortæller API'en om at slette noget, der tidligere blev oprettet. Dette svarer til at bede Slash om at dække (slette) et hul, han tidligere har gravet.

Tænk over disse fire typer. Får du oplysninger, opretter en ny post, ændrer en eksisterende post eller sletter en? Dette svar fortæller dig præcis, hvilken type anmodning du har brug for.

Trin 5: Forstå parametrene

Mange anmodninger kræver yderligere parametre. Parametre er detaljerne i din anmodning. For eksempel, hvis du vil have Slash til at bringe dig alle de bolde, der er røde, skal du angive farven. Hvis du vil have ham til at oprette et nyt hul, skal du fortælle ham, hvor han skal lægge det, og hvor dybt han skal grave.

API -dokumentationen, du refererer til, skal have et afsnit kaldet "Parametre" eller "Indstillinger" for hvert slutpunkt og anmodningstype. Vær opmærksom på, hvilke parametre der kræves, da nogle er valgfri. Hvis en parameter er markeret som valgfri, kan dokumenterne give et eksempel, der også er standard.

Slashs API -parametre kan se sådan ud til at hente bolde:

FÅ

Trin 6: Formater din anmodning

Vi har alle de oplysninger, vi har brug for, nu mangler vi bare at anmode!

Her er to forskellige måder at oprette forbindelse til et API, der ikke kræver kode. Lad os oprette forbindelse til Slash's API for at få sin liste over bolde ved at lave en GET -anmodning til

Parabel - hvis du vil oprette forbindelse til og arbejde med data uden kode

Parabola er en webapp, der giver dig mulighed for nemt at oprette forbindelse til API'er og derefter arbejde med dataene via et visuelt værktøj til træk og slip.