From c2740b05e10d36fa2e7c91b16f2bea6f0dac32f2 Mon Sep 17 00:00:00 2001 From: "Manuel Weiser (aider)" Date: Mon, 2 Sep 2024 11:49:32 +0200 Subject: [PATCH] docs: sortiere README.md nach Spiel- und Benutzerfunktionen --- game_collection/README.md | 262 +++++++++++++++++++------------------- 1 file changed, 131 insertions(+), 131 deletions(-) diff --git a/game_collection/README.md b/game_collection/README.md index f7b8b42..e92956e 100644 --- a/game_collection/README.md +++ b/game_collection/README.md @@ -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/` -- **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/` -- **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/` - **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/` - **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/` +- **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/` +- **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.