docs: update README to document new game search functionality and adjust section numbering

This commit is contained in:
Manuel Weiser 2024-09-02 17:03:10 +02:00
parent a51bf8f0e9
commit 05d936837c

View File

@ -109,7 +109,43 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
}
```
### 5. Benutzer erstellen
### 5. Spiele suchen
- **URL:** `/games/search`
- **Method:** `GET`
- **Query Parameter:**
- `search_keywords`: Das Suchwort für die Spiele.
- **Antwort:**
- **Status 200:** Liste der gefundenen Spiele.
- **Beispiel:**
```json
[
{
"title": "Titel des Spiels",
"link": "URL zum Spiel",
"image_link": "URL zum Bild",
"release_date": "Veröffentlichungsdatum",
"price": "Preis",
"rating": "Bewertung"
}
]
```
- **Status 400:** Kein Suchbegriff angegeben.
- **Beispiel:**
```json
{
"message": "No search term provided!"
}
```
- **Status 500:** Fehler beim Abrufen der Seite.
- **Beispiel:**
```json
{
"message": "Error fetching the page."
}
```
### 6. Benutzer erstellen
- **URL:** `/users`
- **Method:** `POST`
@ -130,7 +166,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
}
```
### 6. Benutzeranmeldung
### 7. Benutzeranmeldung
- **URL:** `/users/login`
- **Method:** `POST`
@ -158,7 +194,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
}
```
### 7. Alle Benutzer abrufen
### 8. Alle Benutzer abrufen
- **URL:** `/users`
- **Method:** `GET`
@ -176,7 +212,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
]
```
### 8. Benutzer bearbeiten
### 9. Benutzer bearbeiten
- **URL:** `/users/<user_id>`
- **Method:** `PUT`
@ -211,7 +247,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
}
```
### 9. Benutzer löschen
### 10. Benutzer löschen
- **URL:** `/users/<user_id>`
- **Method:** `DELETE`