Swagger

Swagger ble brukt som dokumentasjonstjeneste for å sørge for høy kvalitet på backenden. Man kan se swagger visuelt ved å kjøre backenden lokalt og gå inn på hyperlenken under (bytt ut 3000 med portnr)

http://localhost:3000/api/swagger-ui/index.html#/

Lagdeling & HTTP verb

Backenden er delt opp i flere lag, hvor hver kontroller har ett spesifikt felt (i henhold til REST ). Det ble også brukt korrekte HTTP verb for hver operasjon, som f.eks POST for å sende data fra frontend til backend, GET for å hente data fra backend og DELETE for å slette noe fra backend.

Operasjoner

På backenden skrev vi opp operasjoner (en kort beskrivelse) av hva metodene våre gjorde.

Respons

I tillegg til dette skrev vi korte beskrivelser på hva som skjedde når man fikk forskjellige HTTP responskoder (som 200 OK, 400 Bad Request osv)

Api calls & autorisasjon

Med swagger var det også enkelt å teste backendfunksjonene uten å måtte skrive api kall på frontend.

For å bruke de aller fleste funskjonene våre må man være innlogget. Dette gjelder også når man gjør api kallene via swagger. Når man ikke er autorisert ser det slik ut på swagger:

Man kan få autorisasjon via swagger ved å bruke innloggingsmetoden. Man vil da få en respons med en token string:

For å få en token man kan legge inn stringen som innloggingsmetoden returnerte for å autorisere seg. Etter man har gjort det vil swagger se slik ut, og man har tilgang til å gjøre api kall

Eksempel på api kall for innlogget bruker (utføres ved å legge inn eventuelle parametere og trykke execute):

Respons:

Websocket

Oppkobling og abonnering

Websockets blir også brukt i applikasjonen vår, for at meldinger skal fungere optimalt (med direkte oppdatering). Måten websockets fungerer på i applikasjonen vår er at man åpner en websocket kobling på ws://ipadresse:port/ws med hjelp av biblioteket sockjs og så abonnerer på websocketen. Dette vil gjøre at man får direkte oppdatering på meldinger og brukes også til notifikasjoner.