breadcrumb-the-shire/docs/tutorial-08-api-erweitern.md

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

curl -H "Authorization: Bearer <TOKEN>" \
  http://localhost:8080/api/v1/me

Vertiefung

• API-Referenz: /docs/reference-api.md
• Sicherheitsdetails: /docs/explanation-sicherheitsmodell.md