API:et ligger uppe på http://jupiter.umea-ntig.se:3008/. Det är hostat i en container med PM2 på jupiter.
När du loggar in skapas det en JWT token av din info som kommer tillbaka till dig i frontenden och som du ska spara i localstorage. Den tokenen ska skickas med i headern som en authorization på alla requests som görs till API:et. När du loggar ut ska du ta bort tokenen från localstorage.
POST /api/user/:email
Skapar användare eller loggar in användaren. Behöver email från frontend-login, typ session.user.email. Ger tillbaka en JWT-token som ska sparas i localstorage och användas genom att skicka den i header i calls till API:et. För att skicka med den behövs det headern authorization med "Bearer" och JWT-tokenen som värde. Det ser ut ungefär såhär:
fetch("/api/...", {
method: "POST" || "GET" || "DELETE" || "PUT", // använd den rätta av dessa, GET är standard
headers: {
authorization: 'Bearer ' + localStorage.getItem("jwt-token"),
// ^ OBS: mellanslag här
},
})Och utdatat ser ut så här:
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZW1haWwiOiJsdW5kbWFya2hqYWxtYXJAZ21haWwuY29tIiwiaWF0IjoxNzAyMzcxNDkzfQ.G4cX4P_KmIt8vKcvDM81VTjn26TPETZIIJ_NB2l32ps",
}För att logga ut användaren så räcker det att du tar bort JWT-tokenen från localstorage.
localStorage.removeItem("jwt-token");DELETE /api/user
Tar bort användaren från databasen.
GET /api/dish || /api/dish?page=1
Får ut en sida maträtter (40? st) av alla som finns i databasen. Page börja på 0, så /api/dish och /api/dish?page=0 är samma sak. Page=1 är alltså sida 2. Visar saved om användaren har sparat maträtten, annars är saved en tom array.
Utdata:
[
{
"id": 7,
"name": "Cheeseburgare",
"img": "kottbullar_potatismos.jpg",
"desc": "Koka potatis och gör mos. Stek köttbullarna. Servera.",
"categoryOnDish": [
{
"categoryId": 3,
"dishId": 1,
"category": {
"id": 3,
"name": "Kött"
}
}
],
"saved": [
{
"id": 1,
"userId": 14,
"dishId": 1
}
]
},
{
"id": 6,
"name": "Hamburgare",
"img": null,
"desc": null,
"categoryOnDish": [
{
"categoryId": 1,
"dishId": 24,
"category": {
"id": 1,
"name": "Vegetariansk"
}
},
{
"categoryId": 2,
"dishId": 24,
"category": {
"id": 2,
"name": "Vegansk"
}
}
],
"saved": []
},
{
"id": 3,
"name": "Korv med potatismos",
"img": "korv_potatismos.jpg",
"desc": "Koka potatis och gör mos. Stek korven. Servera.",
"categoryOnDish": [],
"saved": []
},
]GET /api/dish/:id
För att få ut en specifik maträtt.
{
"id": 7,
"name": "Cheeseburgare",
"img": "cheeseburgare.jpg",
"desc": null,
"categoryOnDish": [],
"saved": [
{
"id": 1,
"userId": 14,
"dishId": 1
}
]
}GET /api/dish/search/:name
Tar 'name' och visar upp till 10 maträtter som innehåller det namnet. Bör användas för att visa maträtter när användaren ska lägga till ny måltid.
Utdata för '/api/dish/search/burgare'
[
{
"id": 7,
"name": "Cheeseburgare",
"img": "cheeseburgare.jpg",
"desc": null,
"categoryOnDish": [],
"saved": [
{
"id": 1,
"userId": 14,
"dishId": 1
}
]
},
{
"id": 6,
"name": "Hamburgare",
"img": null,
"desc": "stek hamburgare",
"categoryOnDish": [],
"saved": [
{
"id": 1,
"userId": 14,
"dishId": 1
}
]
}
]Du borde kunna använda bilder genom typ denna kod:
<img src={`http://${sida}/api/img/${img}`} />POST /api/dish
För att lägga till en maträtt. Behöver namn data från body samt desc vilket är valfritt, i ett dish objekt.
Body exempel:
{
"dish": {
"name": "Köttbullar med potatismos",
"desc": "Koka potatis och gör mos. Stek köttbullarna. Servera."
}
}GET /api/meal || /api/meal?page=1
Får ut en sida maträtter (40? st) av användarens sparade, i ordningen av senast datum. Page börja på 0, så /api/meal och /api/meal?page=0 är samma sak. Page=1 är alltså sida 2. time bör användas för att visa bara datumet för måltiden, vilken tid det är är inte viktigt.
[
{
"id": 5,
"time": "2023-11-14T11:56:24.198Z",
"type": "lunch",
"icon": "img.png",
"userId": 2,
"dishId": 1,
"dish": {
"id": 1,
"name": "Köttbullar med potatismos"
}
},
{
"id": 4,
"time": "2023-11-14T11:44:54.789Z",
"type": "lunch",
"icon": "img.png",
"userId": 2,
"dishId": 5,
"dish": {
"id": 5,
"name": "Köttbullar och makaroner"
}
},
{
"id": 3,
"time": "2023-11-14T11:44:22.356Z",
"type": "middag",
"icon": null,
"userId": 2,
"dishId": 3,
"dish": {
"id": 3,
"name": "Korv med potatismos"
}
}
]GET /api/meal/search/:name
Tar name och visar de senaste 10 måltiderna som innehåller det namnet. Bör användas för att visa måltider när användaren söker igenom sina uppättna måltider.
[
{
"id": 4,
"time": "2023-11-14T11:44:54.789Z",
"type": "lunch",
"icon": "symbol.png",
"userId": 1,
"dishId": 5,
"dish": {
"id": 5,
"name": "Köttbullar och makaroner"
}
},
{
"id": 1,
"time": "2023-11-14T11:43:00.092Z",
"type": "middag",
"icon": null,
"userId": 1,
"dishId": 1,
"dish": {
"id": 1,
"name": "Köttbullar med potatismos"
}
}
]Du borde kunna använda ikoner genom typ denna kod:
<img src={`http://${sida}/api/img/${icon}`} />POST /api/meal
För att lägga till en måltid. Behöver data från body i ett meal objekt, specifikt time, type och den valda maträttens id (dishId). type ska vara en av lunch eller middag och time ska vara i formatet ISO string.
Enklaste sättet att få ut datumet för morgondagen vad jag har hittat är såhär:
new Date().setDate(new Date().getDate() + 1).toISOString()Body exempel:
{
"meal": {
"time": "2023-11-14T00:00:00.000Z",
"type": "lunch",
"dishId": 1
}
}DELETE /api/meal/:id
För att ta bort en måltid. Behöver id från måltiden som ska tas bort.
GET /api/saved || /api/saved?page=1
Får ut en sida maträtter (40? st) av alla sparade. Page börja på 0, så /api/saved och /api/saved?page=0 är samma sak. Page=1 är alltså sida 2.
[
{
"id": 5,
"userId": 1,
"dishId": 1,
"dish": {
"id": 1,
"name": "Köttbullar med potatismos",
"img": "kottbullar_potatismos.jpg",
"desc": "Koka potatis och gör mos. Stek köttbullarna. Servera.",
}
},
{
"id": 4,
"userId": 1,
"dishId": 5,
"dish": {
"id": 5,
"name": "Köttbullar och makaroner",
"img": "kottbullar_potatismos.jpg",
"desc": "Koka potatis och gör mos. Stek köttbullarna. Servera.",
}
},
{
"id": 3,
"userId": 1,
"dishId": 3,
"dish": {
"id": 3,
"name": "Korv med potatismos",
"img": null,
"desc": null,
}
}
]GET /api/saved/search/:name
Tar name och visar de senaste 10 sparade maträtter som innehåller det namnet. Bör användas för att visa sparade maträtter när användaren söker igenom sina sparade maträtter.
{
"id": 5,
"userId": 1,
"dishId": 1,
"dish": {
"id": 1,
"name": "Köttbullar med potatismos",
"img": "kottbullar_potatismos.jpg",
"desc": "Koka potatis och gör mos. Stek köttbullarna. Servera.",
}
}POST /api/saved
För att lägga till en sparad maträtt. Behöver data från body i en saved objekt, specifikt bara dishId.
Body exempel:
{
"saved": {
"dishId": 1
}
}DELETE /api/saved/:id
För att ta bort en sparad maträtt. Behöver id från maträtten som ska tas bort.
GET /api/category
Får ut alla kategorier som finns i databasen.
[
{
"id": 1,
"name": "Kött"
},
{
"id": 2,
"name": "Fisk"
},
{
"id": 3,
"name": "Vegetariskt"
},
{
"id": 4,
"name": "Veganskt"
}
]GET /api/category/:id
Får ut en specifik kategori och dess maträtter.
{
"id": 1,
"name": "Vegetariansk",
"categoryOnDish": [
{
"categoryId": 1,
"dishId": 18,
"dish": {
"id": 18,
"name": "Pannkakor",
"img": "pannkakor.jpg",
"desc": "Stek pannkakor. Servera med sylt och grädde. "
}
},
{
"categoryId": 1,
"dishId": 19,
"dish": {
"id": 19,
"name": "Tomatsoppa",
"img": "tomatsoppa.jpg",
"desc": "Koka tomatsoppa. Servera. "
}
},
]
}Felmeddelanden kommer ut i denna form:
{
"errors": [
{
"type": "field", // den här är oftast med
"msg": "Invalid value", // den här är alltid med
"path": "jwt-token", // ibland är path och location med, ibland inte
"location": "headers"
}
]
}- Commonjs
- 4 mellanslags-indentering
- camelCase i kod
- snake_case i filnamn
- Semicolon efter varje kod-rad
- Enkelfnuttar
Commit meddelanden ska börja med: feat, fix, docs, style, refactor.
För att testa har jag använt mig av Hoppscotch.io för att köra requests. Om du vill testa kan du ladda ner hoppscotch.json och importera den i Hoppscotch. Vissa requests kanske inte fungerar eller måste uppdateras lite.
- Problem med senaste prisma migrationen
De senaste två migrationerna gjorde några förändringar som har gjort att kategorier inte funkar ibland, mer specifikt att det fungerar lokalt men inte när jag skulle hosta i en container. Koden som inte fungerade är utkommenterad i dish_controller.js och handlar om att ta med categorierna på dishes. Lösningen som jag skulle rekommendera är att resetta prisma, ta bort alla migrationer och ha schema.prisma komplett innan du migrerar för mycket. Vill du inte resetta prisma så kan du följa error meddelandet som man får om man migrerar på nytt eller kör migrate reset.
- Utveckla kategorier
Kategorier var en funktion jag gjorde lite snabbt på slutet och skulle kunna bli bättre.
- Planera med frontend gruppen
Det viktigaste är att planera med frontend gruppen så du vet vad de vill ha och vad de behöver.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent