leerzeieln weil nvim heult

This commit is contained in:
Technoir committed 2026-10-19 16:03:06 +02:00
1 parent af46c19651
commit bb60da6aaa
1 file changed
+74 -12
+74 -12
View File
@@ -1,5 +1,7 @@
# API
Die API versucht möglichst RESTful zu sein. Es hat:
- Ressourcen im Plural
- Client-Server Trennung, Änderung der Daten auf der Oberfläche geschieht über `fetch()` an die API
- Einheitliche Schnittstelle
@@ -9,6 +11,7 @@ Die Schnittstelle erfolgt vollständig über JSON.
Es wurde auf Cache-fähigkeit verzichtet aus Zeitgründen. HATEOAS ist auch nicht vorhanden, da Zeitgründe und fragwürdig, ob es für ein Projekt diesen Umfang nötig ist.
## API Pfade
IDs sind im UUID Format
### Listen `/api/lists`
@@ -17,10 +20,15 @@ IDs sind im UUID Format
| ------------ | -------- | --------------------------------------------------- | ----------------------------------------- | ------------ |
| `/api/lists` | `GET` | Gibt alle vorhandenen Listen zurück mit Name und ID | / | 200 |
| | `POST` | Erlaubt es eine neue Liste zu erstellen | `listName` für den gewünschten Listenname | 201 |
#### `GET /api/lists` - Alle Listen
##### Body Beispiel
Leer
##### Response Beispiel
```json
[
{
@@ -34,21 +42,26 @@ Leer
...
]
```
#### `POST /api/lists` - Erstellen einer Liste
##### Body Beispiel
```json
{
"listName": "Listenname"
"listName": "Listenname"
}
```
##### Response Beispiel
```json
{
"listName": "Listenname",
"listID": "ddb3ac36-8213-4f9d-bf1e-39c836768e57"
"listName": "Listenname",
"listID": "ddb3ac36-8213-4f9d-bf1e-39c836768e57"
}
```
### Liste `/api/lists`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
@@ -56,10 +69,15 @@ Leer
| `/api/lists/{id}` | GET | Gibt alle Gegenstände und Kategorien (mit ihren Gegenständen) in der Liste mit der UUID id zurück | `id`: UUID der Liste in der URL | 200 |
| | PATCH | Verändert den Namen der Liste | `id`: UUID der Liste in der URL. Im Body `listName` für den neuen Namen | 204 |
| | DELETE | löscht eine Liste | `id`: UUID Der Liste in der URL | 204 |
#### GET `/api/lists/{id}` - Inhalt der Liste
##### Body Beispiel
/
##### Response Beispiel
```json
{
"categories": [
@@ -98,25 +116,33 @@ Leer
]
}
```
#### `PATCH /api/lists/{id}` - Bearbeiten der Liste
##### Body
```json
{
"listName": "neuer Listname"
"listName": "neuer Listname"
}
```
##### Response
/
#### `DELETE /api/lists/{id}` - Löschen einer Liste
##### Body
/
##### Response
/
#### `DELETE /api/lists/{id}` - Löschen einer Liste
##### Body
/
##### Response
/
### Kategorien `/api/categories`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ---------------------- | -------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `/api/categories/{id}` | `GET` | Gibt den Inhalt der Kategorie zurück | / | 200 |
@@ -124,11 +150,14 @@ Leer
| | `PATCH` | Ändern vom Namen der Liste | `categoryName` im Body für neuen Kategorienamen | 204 |
| | `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",
@@ -145,38 +174,53 @@ Leer
"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
##### Body
/
##### Response
/
### Gegenstände `/api/items`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ----------------- | -------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `/api/items/{id}` | `GET` | Gibt den Inhalt des Gegenstands zurück | / | 200 |
@@ -185,9 +229,13 @@ Leer
| | `DELETE` | Löschen eines Gegenstands | / | 204 |
#### `GET /api/items/{id}` - Inhalt des Gegenstands
##### Body Beispiel
/
##### Response Beispiel
```json
{
"status": false,
@@ -198,9 +246,11 @@ Leer
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
#### `POST /api/items` - Erstellen eines Gegenstands
##### Body Beispiel
```json
{
"itemName": "Milch",
@@ -209,7 +259,9 @@ Leer
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
##### Response Beispiel
```json
{
"itemName": "Milch",
@@ -218,17 +270,27 @@ Leer
"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
/