docs: restructure docs to diataxis and finalize DOCS-RESTRUCTURE-001

This commit is contained in:
2026-03-06 12:25:18 +01:00
parent 9caa0a4f75
commit 72886f4784
49 changed files with 564 additions and 180 deletions

View File

@@ -0,0 +1,32 @@
# API erweitern
Letzte Aktualisierung: 2026-03-06
## 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
- API-Referenz: `/docs/reference-api.md`
- Sicherheitsdetails: `/docs/explanation-sicherheitsmodell.md`