docs: update README to include user management features and endpoints
This commit is contained in:
parent
069b318f0b
commit
204ceb489a
@ -43,8 +43,74 @@ Dies ist ein Backend mit Flask, das eine Sammlung von Spielen verwaltet und eine
|
|||||||
"date": "Kaufdatum",
|
"date": "Kaufdatum",
|
||||||
"buyer": "Name des Käufers",
|
"buyer": "Name des Käufers",
|
||||||
"owned": true
|
"owned": true
|
||||||
},
|
}
|
||||||
...
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
- **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"
|
||||||
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user