beispiele für Items und Kategorien hinzugefügt

This commit is contained in:
Technoir committed 2026-10-19 11:25:47 +02:00
1 parent 57c541bbb7
commit 8e3c6b8c36
1 file changed
+93
+93
View File
@@ -125,6 +125,50 @@ Leer
| | `DELETE` | Löschen einer Liste | `deleteAllItems=(true\|false)` als Queryparameter. Entscheidet, ob Gegenstände in der Kategorie mitgelöscht werden sollen | 204 |
#### `GET /api/categories/{id}` - Inhalt der Kategorie
##### Body Beispiel
/
##### Response Beispiel
```json
{
"categoryName": "testkategorie",
"items": [
{
"status": false,
"itemName": "test",
"itemAmount": "1",
"itemID": "99403d02-4771-4a5a-b6a7-6f3af0a5ee84",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
],
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `POST /api/categories` - Erstellen einer Kategorie
##### Body Beispiel
```json
{
"categoryName": "testKategorie",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
##### Response Beispiel
```json
{
"categoryName": "testKategorie",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `PATCH /api/categories/{id}` - Bearbeiten der Kategorie
##### Body Beispiel
```json
{
"categoryName": "Gemüse"
}
```
##### Response
/
#### `DELETE /api/categories/{id}?deleteAllItems=(true|false)`
##### Body
@@ -139,3 +183,52 @@ Leer
| | `POST` | Erlaubt es einen neuen Gegenstand zu erstellen | `itemName,itemAmount,categoryID?,listID` im Body, für den Namen und Menge (entweder beide oder mindst einer muss vorhanden sein). | 201 |
| | `PATCH` | Ändern vom Namen, Menge oder Status eines Gegenstands | `itemName, itemAmount, isDone, categoryID` im Body. | 204 |
| | `DELETE` | Löschen eines Gegenstands | / | 204 |
#### `GET /api/items/{id}` - Inhalt des Gegenstands
##### Body Beispiel
/
##### Response Beispiel
```json
{
"status": false,
"itemName": "Milch",
"itemAmount": "1L",
"itemID": "38a0991e-4b51-42d7-b12c-0ddbcf6f583e",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
#### `POST /api/items` - Erstellen eines Gegenstands
##### Body Beispiel
```json
{
"itemName": "Milch",
"itemAmount": "1L",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
##### Response Beispiel
```json
{
"itemName": "Milch",
"itemAmount": "1L",
"itemID": "38a0991e-4b51-42d7-b12c-0ddbcf6f583e",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `PATCH /api/items/{id}` - Bearbeiten eines Gegenstands
##### Body Beispiel
```json
{
"isDone": true
}
```
##### Response
/
#### `DELETE /api/items/{id}` - Löschen eines Gegenstands
##### Body
/
##### Response
/