2026-03-04 15:56:58 +01:00
|
|
|
# API erweitern
|
|
|
|
|
|
2026-03-06 12:25:18 +01:00
|
|
|
Letzte Aktualisierung: 2026-03-06
|
2026-03-04 15:56:58 +01:00
|
|
|
|
|
|
|
|
## Ziel
|
|
|
|
|
|
|
|
|
|
API-Änderungen konsistent ausrollen (Code + Spec + Test).
|
|
|
|
|
|
|
|
|
|
## Ablauf
|
|
|
|
|
|
|
|
|
|
1. Endpoint in `pages/api/v1/**` anpassen.
|
|
|
|
|
2. Service/Repository bei Bedarf erweitern.
|
|
|
|
|
3. OpenAPI in `/docs/openapi.yaml` im selben Change aktualisieren.
|
|
|
|
|
4. Endpoint per cURL/Postman gegenprüfen.
|
|
|
|
|
|
|
|
|
|
## API-Regeln
|
|
|
|
|
|
|
|
|
|
- UUID-first nach außen
|
|
|
|
|
- Einheitliche Fehlerstruktur (`error`, optional `errors`)
|
|
|
|
|
- Auth/Scope-Regeln unverändert einhalten
|
|
|
|
|
|
|
|
|
|
## Minimaltest
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
curl -H "Authorization: Bearer <TOKEN>" \
|
|
|
|
|
http://localhost:8080/api/v1/me
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Vertiefung
|
|
|
|
|
|
2026-03-06 12:25:18 +01:00
|
|
|
- API-Referenz: `/docs/reference-api.md`
|
|
|
|
|
- Sicherheitsdetails: `/docs/explanation-sicherheitsmodell.md`
|
