DirektiveDesDons/Documentation/Dokumentation.md
2023-01-24 08:47:05 +01:00

1.6 KiB

Dokumentation

Eine auflistung von allen Funktionen und API-Endpunkten mit Erklärung.

  • User
  • Einkaufsliste
  • Zutaten
  • Einheiten

User

User erstellen

POST 127.0.0.1/DirektiveDesDons/user

BODY
{
  "username": "Benutzername",
  "email": "email"
  "password": "Passwort",
}

Aktueller User ausgeben

GET 127.0.0.1/DirektiveDesDons/user

Daten des akteullen User ändern

PUT 127.0.0.1/DirektiveDesDons/user

BODY
{
  "username": "Benutzername",
  "password": "Passwort"
}

Login

POST 127.0.0.1/DirektiveDesDons/login

BODY
{
  "username": "Benutzername",
  "password": "Passwort"
}

Einkaufsliste

Einkaufsliste erstellen

POST 127.0.0.1/DirektiveDesDons/shoppinglist

BODY
{
  "name": "Einkaufsliste 1"
  "backgoundColor": "#123",
}

Einkauslisten ausgeben

GET 127.0.0.1/DirektiveDesDons/shoppinglist

Einkaufsliste ausgeben

GET 127.0.0.1/DirektiveDesDons/shoppinglist/1

Zutat zu Einkaufsliste hinzufügen

POST 127.0.0.1/DirektiveDesDons/shoppinglist/1

BODY
{
  "ingredientId": 1
}

Zutaten

Zutaten erstellen

POST 127.0.0.1/DirektiveDesDons/ingredient

BODY
{
  "name": "Nüsse",
  "calories": "123",
  "quantity": "5",
  "unit": "st",
  "price": "12.5"
}

Zutaten ausgeben

GET 127.0.0.1/DirektiveDesDons/ingredient

Zutat ausgeben

GET 127.0.0.1/DirektiveDesDons/ingredient/1

MengenEinheiten

Einheiten auflisten

GET 127.0.0.1/DirektiveDesDons/unit

Einheit Erstellen

POST 127.0.0.1/DirektiveDesDons/unit

BODY
{
  "name": "lbs"
}