Skip to content
Snippets Groups Projects
Commit 3a3b6663 authored by Mathilde Hertaas's avatar Mathilde Hertaas
Browse files

further improvment of Readme file

parent 0653c318
No related branches found
No related tags found
No related merge requests found
### Assignment 1 # Assignment 1
## Kjøre koden
Koden kjøres ved å skrive følgende kommando i terminalen:
```sh
go run main.go
```
Når serveren starter, kan du åpne nettleseren og navigere til:
* http://localhost:8080/ - Dette er hjemmesiden til API-et.
- Når serveren startes er det hit du eventuelt blir sendt automatisk
* Alternativt kan du bruke en av endepunktene beskrevet nedenfor for å navigere applikasjonen
## Kjøre koden
koden kjøres ved å skrive go run main.go i temrinalen
- Da blir du eventuelt automatisk sendt til
http://localhost:8080/
Dette er Hjemmeside
- Eventuelt kan du bruke fremgangsmåtene under Endepunkter for å navigere applikajsonen
## Hjemmeside (/) ## Hjemmeside (/)
Når du åpner API-et uten spesifikke forespørsler (http://localhost:8080/), Når du åpner API-et uten spesifikke forespørsler (http://localhost:8080/), vil du få en JSON-respons med informasjon om hvordan du bruker API-et.
vil du bli sendt til en JSON-side med informasjon om hvordan du bruker API-et.
Her får du informasjon om de tre endepunktene som er tilgjengelige: Her får du informasjon om de tre tilgjengelige endepunktene:
1. info 1. info - Henter generell informajson om et land.
2. populasjon 2. populasjon - Henter populasjonsdata for et land.
3. status 3. status - Viser status for API-et.
Du får også se hvordan riktig format av url forespørsel til en av disse endepunktene
vil se ut og eksempler på riktig bruk.
I tillegg vises eksempler på hvordan du kan sende forespørsler til de ulike endepunktene.
## Endepunkter ## Endepunkter
#info ### info
1. Hente informasjon om et land basert på en 2-letter country codes (ISO 3166-2). 1. Hente informasjon om et land basert på en 2-bokstavs landkode (ISO 3166-2).
* Endpoint: /countryinfo/v1/info/{country_code}{?limit=10} ```sh
http://localhost:8080/countryinfo/v1/info/{country_code}{?limit=10}
```
* Metode: GET * Metode: GET
* Eksempel: http://localhost:8080/countryinfo/v1/info/NO?limit=4 * Eksempel: http://localhost:8080/countryinfo/v1/info/NO?limit=4
#populasjon #### populasjon
2. Hente populasjonsdata 2. Hente populasjonsdata om et land basert på en 2-bokstavs landkode (ISO 3166-2).
GET http://localhost:8080/population/NO ```sh
GET http://localhost:8080/population/NO?limit=2010-2015 http://localhost:8080/countryinfo/v1/population/{country_code}{?startyear-endYear}
```
*Metode: GET
* Eksempel: http://localhost:8080/population/NO?limit=2010-2015
### status
3. Viser status for de eksterne API-ene, versjon og applikasjonens oppetid.
```sh
http://localhost:8080/countryinfo/v1/status
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment