Italienische-Mafia/DirektiveDesDons
4
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Johannes Kantz
2023-01-24 09:01:42 +01:00
parent c8582c8813
commit 62ac1011cc
1 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
Documentation/Dokumentation.md
View File

@@ -28,17 +28,6 @@ BODY
GET 127.0.0.1/DirektiveDesDons/user GET 127.0.0.1/DirektiveDesDons/user
``` ```
### Daten des akteullen User ändern
```shell
PUT 127.0.0.1/DirektiveDesDons/user
BODY
{
"username": "Benutzername",
"password": "Passwort"
}
```
### Login ### Login
```shell ```shell
POST 127.0.0.1/DirektiveDesDons/login POST 127.0.0.1/DirektiveDesDons/login
@@ -56,7 +45,7 @@ BODY
### Einkaufsliste erstellen ### Einkaufsliste erstellen
```shell ```shell
POST 127.0.0.1/DirektiveDesDons/shoppinglist POST 127.0.0.1/DirektiveDesDons/list
BODY BODY
{ {
@@ -67,17 +56,22 @@ BODY
### Einkauslisten ausgeben ### Einkauslisten ausgeben
```shell ```shell
GET 127.0.0.1/DirektiveDesDons/shoppinglist GET 127.0.0.1/DirektiveDesDons/list
``` ```
### Einkaufsliste ausgeben ### Einkaufsliste ausgeben
```shell ```shell
GET 127.0.0.1/DirektiveDesDons/shoppinglist/1 GET 127.0.0.1/DirektiveDesDons/list/1
```
### Einkaufsliste löschen
```shell
DELETE 127.0.0.1/DirektiveDesDons/list/1
``` ```
### Zutat zu Einkaufsliste hinzufügen ### Zutat zu Einkaufsliste hinzufügen
```shell ```shell
POST 127.0.0.1/DirektiveDesDons/shoppinglist/1 POST 127.0.0.1/DirektiveDesDons/list/1
BODY BODY
{ {
@@ -85,6 +79,11 @@ BODY
} }
``` ```
### Zutat von Liste löschen
```shell
DELETE 127.0.0.1/DirektiveDesDons/list/1/4
```
--- ---
## Zutaten ## Zutaten
@@ -113,6 +112,11 @@ GET 127.0.0.1/DirektiveDesDons/ingredient
GET 127.0.0.1/DirektiveDesDons/ingredient/1 GET 127.0.0.1/DirektiveDesDons/ingredient/1
``` ```
### Zutat löschen
```shell
DELETE 127.0.0.1/DirektiveDesDons/ingredient/1
```
--- ---
## MengenEinheiten ## MengenEinheiten
@@ -121,6 +125,7 @@ GET 127.0.0.1/DirektiveDesDons/ingredient/1
```shell ```shell
GET 127.0.0.1/DirektiveDesDons/unit GET 127.0.0.1/DirektiveDesDons/unit
``` ```
### Einheit Erstellen ### Einheit Erstellen
```shell ```shell
POST 127.0.0.1/DirektiveDesDons/unit POST 127.0.0.1/DirektiveDesDons/unit
@@ -130,3 +135,8 @@ BODY
"name": "lbs" "name": "lbs"
} }
``` ```
### Einheit löschen
```shell
DELETE 127.0.0.1/DirektiveDesDons/unit/4
```