docs: sortiere README.md nach Spiel- und Benutzerfunktionen
This commit is contained in:
parent
b9dfa6adba
commit
c2740b05e1
@ -47,136 +47,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
|
||||
]
|
||||
```
|
||||
|
||||
### 3. Benutzer erstellen
|
||||
|
||||
- **URL:** `/users`
|
||||
- **Method:** `POST`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Benutzername",
|
||||
"password": "Passwort",
|
||||
"role": "user/admin" # Optional, Standard ist 'user'
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 201:** Benutzer erfolgreich erstellt (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User created!"
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Benutzeranmeldung
|
||||
|
||||
- **URL:** `/users/login`
|
||||
- **Method:** `POST`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Benutzername",
|
||||
"password": "Passwort"
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 200:** Anmeldung erfolgreich.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Login successful!",
|
||||
"role": "user/admin"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Ungültige Anmeldedaten.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Invalid credentials!"
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Alle Benutzer abrufen
|
||||
|
||||
- **URL:** `/users`
|
||||
- **Method:** `GET`
|
||||
- **Antwort:**
|
||||
- **Status 200:** Liste aller Benutzer.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"username": "Benutzername",
|
||||
"role": "user/admin",
|
||||
"last_login": "2023-10-01 12:00:00"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### 6. Benutzer bearbeiten
|
||||
|
||||
- **URL:** `/users/<user_id>`
|
||||
- **Method:** `PUT`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Neuer Benutzername",
|
||||
"role": "user/admin", # Optional
|
||||
"password": "Neues Passwort" # Optional, Passwort kann bearbeitet werden, wird aber nicht angezeigt
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 200:** Benutzer erfolgreich aktualisiert (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User updated!"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Unbefugter Zugriff.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Unauthorized access! Only admins can edit users."
|
||||
}
|
||||
```
|
||||
- **Status 404:** Benutzer nicht gefunden.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User not found!"
|
||||
}
|
||||
```
|
||||
|
||||
### 7. Benutzer löschen
|
||||
|
||||
- **URL:** `/users/<user_id>`
|
||||
- **Method:** `DELETE`
|
||||
- **Antwort:**
|
||||
- **Status 200:** Benutzer erfolgreich gelöscht (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User deleted!"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Unbefugter Zugriff.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Unauthorized access! Only admins can delete users."
|
||||
}
|
||||
```
|
||||
- **Status 404:** Benutzer nicht gefunden.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User not found!"
|
||||
}
|
||||
```
|
||||
|
||||
### 8. Spiel bearbeiten
|
||||
### 3. Spiel bearbeiten
|
||||
|
||||
- **URL:** `/games/<game_id>`
|
||||
- **Method:** `PUT`
|
||||
@ -211,7 +82,7 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
|
||||
}
|
||||
```
|
||||
|
||||
### 9. Spiel löschen
|
||||
### 4. Spiel löschen
|
||||
|
||||
- **URL:** `/games/<game_id>`
|
||||
- **Method:** `DELETE`
|
||||
@ -238,6 +109,135 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
|
||||
}
|
||||
```
|
||||
|
||||
### 5. Benutzer erstellen
|
||||
|
||||
- **URL:** `/users`
|
||||
- **Method:** `POST`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Benutzername",
|
||||
"password": "Passwort",
|
||||
"role": "user/admin" # Optional, Standard ist 'user'
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 201:** Benutzer erfolgreich erstellt (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User created!"
|
||||
}
|
||||
```
|
||||
|
||||
### 6. Benutzeranmeldung
|
||||
|
||||
- **URL:** `/users/login`
|
||||
- **Method:** `POST`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Benutzername",
|
||||
"password": "Passwort"
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 200:** Anmeldung erfolgreich.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Login successful!",
|
||||
"role": "user/admin"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Ungültige Anmeldedaten.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Invalid credentials!"
|
||||
}
|
||||
```
|
||||
|
||||
### 7. Alle Benutzer abrufen
|
||||
|
||||
- **URL:** `/users`
|
||||
- **Method:** `GET`
|
||||
- **Antwort:**
|
||||
- **Status 200:** Liste aller Benutzer.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"username": "Benutzername",
|
||||
"role": "user/admin",
|
||||
"last_login": "2023-10-01 12:00:00"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### 8. Benutzer bearbeiten
|
||||
|
||||
- **URL:** `/users/<user_id>`
|
||||
- **Method:** `PUT`
|
||||
- **Body:**
|
||||
```json
|
||||
{
|
||||
"username": "Neuer Benutzername",
|
||||
"role": "user/admin", # Optional
|
||||
"password": "Neues Passwort" # Optional, Passwort kann bearbeitet werden, wird aber nicht angezeigt
|
||||
}
|
||||
```
|
||||
- **Antwort:**
|
||||
- **Status 200:** Benutzer erfolgreich aktualisiert (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User updated!"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Unbefugter Zugriff.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Unauthorized access! Only admins can edit users."
|
||||
}
|
||||
```
|
||||
- **Status 404:** Benutzer nicht gefunden.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User not found!"
|
||||
}
|
||||
```
|
||||
|
||||
### 9. Benutzer löschen
|
||||
|
||||
- **URL:** `/users/<user_id>`
|
||||
- **Method:** `DELETE`
|
||||
- **Antwort:**
|
||||
- **Status 200:** Benutzer erfolgreich gelöscht (nur für Administratoren).
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User deleted!"
|
||||
}
|
||||
```
|
||||
- **Status 401:** Unbefugter Zugriff.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "Unauthorized access! Only admins can delete users."
|
||||
}
|
||||
```
|
||||
- **Status 404:** Benutzer nicht gefunden.
|
||||
- **Beispiel:**
|
||||
```json
|
||||
{
|
||||
"message": "User not found!"
|
||||
}
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
1. Klone das Repository.
|
||||
|
Loading…
Reference in New Issue
Block a user