Utfør din første API-forespørsel i Snarveier på Mac
For å forespørre din første API må du opprette URL-en som peker på «API-sluttpunktet» du vil snakke med, og deretter sende URL-en til Hent innhold på URL-handlingen. Når snarveien utføres, oppretter denne handlingen API-forespørselen.
Bygg API-forespørselen
Typicode-sluttpunkt krever at en URL-forespørsel er formatert på denne måten:
https://jsonplaceholder.typicode.com/[RESOURCE]
Teksten i hakeparentesene er ressursen du vil ha tilgang til. Typicode har mange ulike eksempler for testing av forespørsler. Dette eksemplet bruker https://jsonplaceholder.typicode.com/users til å be om en liste over brukere.
I Snarveier-appen
på Macen kan du legge forespørselen til URL-en.Forespørselen om
usersreturnerer en liste med brukere.Du kan begrense søket ved å spesifisere en bestemt bruker etter ID:
https://jsonplaceholder.typicode.com/users/6. Dette returnerer brukeren med ID-en 6.De fleste API-ene tillater at forespørsler kan bruke følgende format:
https://jsonplaceholder.typicode.com/users?username=Bret. «?» starter forespørselen, som søker etter objekter med nøkkel/verdipar. I dette eksempelet søker forespørselen?username=Bretetter en bruker med brukernavnet Bret.Se API-ens dokumentasjon for støttede søk og forespørsler.
Utfør API-forespørselen med Hent innhold på URL-handlingen
I Snarveier-appen
på Macen kan du klikke på Vis flere i Hent innhold på URL-handlingen.Følgende alternativer for API-forespørsler du kan opprette, blir tilgjengelig:
GETgjør det mulig å hente data.POSTgjør det mulig å opprette nye data.PUTgjør det mulig å oppdatere data ved å erstatte det.PATCHgjør det mulig å oppdatere data ved å endre det.DELETEgjør det mulig å fjerne et objekt angitt i URL-forespørselen.
I dette eksempelet bruker du en
GET-forespørsel til å hente data fra Typicode API-en.Nå som URL-handlingen har forespørselen din og Hent innhold på URL-handlingen er konfigurert til å hente (
GET) data, er du klar til å opprette API-forespørselen.Merk: Når Hent innhold på URL-handlingen byttes til
POST,PUTellerPATCH, legges det til en ny parameter som heter Forespørselstekst. Forespørselstekst gjør det mulig å sende JSON, et Skjema eller en Fil til API-en som en del av forespørselen. Dette gjør det mulig å angi nye data manuelt eller ved hjelp av variabler, slik at du kan sende dataene til API for å opprette, erstatte eller modifisere en oppføring.Hvis du vil teste snarveien, klikker du på
.
Ved første øyekast ser API-en ut til å ha returnert rotete tekst. Dataene er kodet i JSON-format, som er en forkortelse for JavaScript Object Notation.
Hvis du vil vite mer om hvordan du kan bruke JSON, og fortsette å arbeide med Typicode API-eksempelet, leser du Introduksjon til bruk av JSON i Snarveier på Mac.