Vad är ett api?
Ett api är ett sätt för en dator att prata med en annan. I vårt fall vill vi få restauranger och krogar att, på ett enkelt sätt, prata med vår databas där vi har information om dina allergier. Detta gör det möjligt att skapa exempelvis digitala menyer som automatiskt filtreras utifrån vad du kan, och inte kan, äta.
Hämta alla allergener
För att visa hur det går till kan vi börja med att hämta alla allergener i vår databas. Det gör du genom följande address: /api/allergen
.
Du får då ett svar i json-format där alla allergener listas i en lista. Json är ett praktiskt format för api:er då det är lätt att läsa, både för människor och för datorer.
Vill du nu få ut information om en specifik allergen kan du lägga till id-nummret i addressen. Detta kan se ut såhär: /api/allergen/2
. Som du ser får du nu bara ut en allergen från databasen.
Hämta profil och deras allergier
Men den absolut bästa användningen för vårt api är att hämta ut en specifik profils allergier. Detta gör du genom att besöka /api/profile/J6PL6
. Där J6PL6
är profilens unika kod. Då får du tillbaka en lista i json-format med profilens namn och samtliga allergier.
Spara och ändra profil allergier
Restauranger kan också genom vårt api lägga till och ta bort allergier enligt kundens önskemål. För att lägga till en allergi besöker du /api/profile/J6PL6/add/2
. Du kommer nu lägga till allergenen med id:t 2
till profilen med koden J6PL6
.
Vill du sedan ta bort denna allergen besöker du /api/profile/J6PL6/remove/2
. Båda dessa addresser returnerar profilens namn och samtliga allergier, som de ser ut efter den genomförda förändringen.
Lathund
Funktion | Adress |
---|---|
Alla allergener | /api/allergen/ |
En allergen | /api/allergen/{id} |
En profil | /api/profile/{code} |
Lägg till allergi | /api/profile/{code}/add/{id} |
Ta bort allergi | /api/profile/{code}/remove/{id} |