Informasjonen, på denne siden, omhandler REST API, på et generelt grunnlag, og er ikke spesifikk mot REST API i View Maintenance. Teksten er hentet fra Wikipedia.

Programmering mot et REST API, krever grunnleggende programmerings forståelse.

Programmeringsgrensesnitt

Et programmeringsgrensesnitt, kjent på engelsk som application programming interface (API), er et grensesnitt i en programvare som gjør at spesifikke deler av denne kan aktiveres («kjøres») fra en annen programvare. Det betyr at svært enkle applikasjoner (ofte webapplikasjoner) kan gjøre endringer, kjøre prosesser eller på annen måte behandle data i en større kontekst. Slike samarbeidende programvaredeler betegnes gjerne som komponenter. Man ser dette ofte brukt i for eksempel behandling av data i en database.

API-et beskriver de metoder som en gitt programvare eller et bibliotek kan kommunisere med. Ofte benyttes API-et som et lag eller grensesnitt mellom høynivå- og lavnivåprogrammering. API-et er abstrakt og fungerer som en regelbok for kall til applikasjonen eller kodebiblioteket. Koden som utføres kalles for en implementasjon. Eksempelvis er Wine en implementasjon av Win32. Typiske prosesser man kan gjøre med et API er GET (hvor man henter ut data fra for eksempel en database), PUT (hvor man gjør endringer på spesifikke objekt i for eksempel en database) og POST (hvor man legger til data i for eksempel en database).

Bruksområder

Typiske bruksområder for et API er for å gi brukere og utviklere tilgang til spesifikke data i en organisasjon/applikasjon. Eksempelvis har LastFM et åpent API hvor man kan blant annet hente ut informasjon om tid og sted for konserter, sanger på et album, informasjon om en artist og mer. Ved å tilby en slik tjeneste vil altså LastFM tilby sine tjenester på en indirekte måte, ved at "hvem som helst" kan utvikle en applikasjon som benytter seg av data levert av LastFM.

En «sosial API» ble lansert av eBay, som del av et grensesnitt til det lokasjonsbaserte sosiale nettverket til eBay i 2000.

API dokumentasjon

Dokumentasjonen for et programmeringsgrensesnitt beskriver hvilke tjenester som tilbys og hvordan det skal brukes. Formålet med dokumentasjonen er å gi brukeren nødvendig informasjon for å kunne gjøre API kall og få tilbake data.

Dokumentasjonen for et API er essensiell for en utvikler ettersom at den definerer hva slags kode som skal skrives i applikasjonen til utvikleren.

REST API

REST står for REpresentational State Transfer. Når et REST API kalles, vil serveren overføre en representasjon av tilstanden til den etterspurte ressursen. Denne representasjonen kan være skrevet i JSON, XML eller HTML format.

En REST webapplikasjon eksponerer informasjon om tjenestene til klienter. Klientene kan utføre oppgaver baser på denne informasjonen.

For at et API skal være i REST tilstand må det følges et sett med begrensninger når det skrives. Disse begrensningene vil gjøre det enklere for utviklere som har mindre erfaring med API kall.

  • No labels