core/Projektarbeit-MYP
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Aktualisiere API-Dokumentation für lokale Authentifizierung

Browse Source 
- Entferne JWT-Token-basierte Authentifizierung
- Füge Endpunkte für Benutzerregistrierung und -anmeldung hinzu
- Dokumentiere neuen Endpunkt für initialen Admin-Setup

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
root 2025-03-11 09:28:52 +01:00
parent 61b5a4a67c
commit f480ed00bd
1 changed files with 63 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
backend/API_DOCS.md
View File

@ -8,35 +8,32 @@ Die Basis-URL für alle API-Anfragen ist: `http://localhost:5000` (Entwicklungsu
## Authentifizierung ## Authentifizierung
Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über einen JWT-Token, der im Authorization-Header übermittelt wird: Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cookies/Sessions, die bei der Anmeldung erstellt werden. Die Session wird für 7 Tage gespeichert.
``` ### Benutzerregistrierung
Authorization: Bearer <token>
```
Der Token wird bei erfolgreicher Anmeldung zurückgegeben und hat eine Gültigkeitsdauer von 24 Stunden. **Endpunkt:** `POST /auth/register`
### Benutzeranmeldung **Beschreibung:** Registriert einen neuen Benutzer im System.
**Endpunkt:** `POST /api/auth/login`
**Beschreibung:** Meldet einen Benutzer an und gibt einen JWT-Token zurück.
**Request-Body:** **Request-Body:**
```json ```json
{ {
"username": "string", "username": "string", // Erforderlich
"password": "string" "password": "string", // Erforderlich
"displayName": "string", // Optional (Standard: username)
"email": "string" // Optional
} }
``` ```
**Erfolgsantwort:** **Erfolgsantwort:**
```json ```json
{ {
"token": "string", "message": "Registrierung erfolgreich!",
"user": { "user": {
"id": 1, "id": "string",
"username": "string", "username": "string",
"displayName": "string",
"email": "string", "email": "string",
"role": "string" "role": "string"
} }
@ -46,36 +43,79 @@ Der Token wird bei erfolgreicher Anmeldung zurückgegeben und hat eine Gültigke
**Fehlerantwort:** **Fehlerantwort:**
```json ```json
{ {
"message": "Ungültige Anmeldedaten!" "message": "Benutzername bereits vergeben!"
} }
``` ```
### Benutzerregistrierung ### Benutzeranmeldung
**Endpunkt:** `POST /api/auth/register` **Endpunkt:** `POST /auth/login`
**Beschreibung:** Registriert einen neuen Benutzer. **Beschreibung:** Meldet einen Benutzer an und erstellt eine Session.
**Request-Body:** **Request-Body:**
```json ```json
{ {
"username": "string", "username": "string", // Erforderlich
"email": "string", "password": "string" // Erforderlich
"password": "string"
} }
``` ```
**Erfolgsantwort:** **Erfolgsantwort:**
```json ```json
{ {
"message": "Benutzer erfolgreich registriert!" "message": "Anmeldung erfolgreich!",
"user": {
"id": "string",
"username": "string",
"displayName": "string",
"email": "string",
"role": "string"
}
} }
``` ```
**Fehlerantwort:** **Fehlerantwort:**
```json ```json
{ {
"message": "Benutzername bereits vergeben!" "message": "Ungültiger Benutzername oder Passwort!"
}
```
### Initialer Administrator
**Endpunkt:** `POST /api/create-initial-admin`
**Beschreibung:** Erstellt einen initialen Admin-Benutzer, falls noch keiner existiert.
**Request-Body:**
```json
{
"username": "string", // Erforderlich
"password": "string", // Erforderlich
"displayName": "string", // Optional (Standard: username)
"email": "string" // Optional
}
```
**Erfolgsantwort:**
```json
{
"message": "Administrator wurde erfolgreich erstellt!",
"user": {
"id": "string",
"username": "string",
"displayName": "string",
"email": "string",
"role": "string"
}
}
```
**Fehlerantwort:**
```json
{
"message": "Es existiert bereits ein Administrator!"
} }
``` ```