From 317106e5190f6e78c577b592cf525cfc333f47e3 Mon Sep 17 00:00:00 2001 From: Mathilde Hertaas <maimh@stud.ntnu.no> Date: Wed, 26 Feb 2025 08:49:50 +0000 Subject: [PATCH] edited readme file to include a draft with some informasion --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index bd0d090..62922b5 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ # Cloud Project + + +# Endepunkter + 1. Hente informasjon om et land basert på en 2-letter country codes (ISO 3166-2). + * Endpoint: /countryinfo/v1/info/{country_code}{?limit=10} + * Metode: GET + * Eksempel: http://localhost:8080/countryinfo/v1/info/NO + + +# Hjemmeside (/) +Når du åpner API-et uten spesifikke forespørsler (http://localhost:8080/), +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: + 1. info + 2. populasjon + 3. status +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. \ No newline at end of file -- GitLab