Files
2026-07-08 16:15:37 +02:00

3.9 KiB

M161 — Public-API: OpenAPI-Spec + Read-Endpoints

Block: Block 7 · Modul 34 Pflichtenheft-Quelle: block7.md Abschnitt 34.1, 34.4

Ziel

Read-API mit Endpoints für Kontakte, Firmen, Projekte, Aufgaben, Leads (Liste+Detail). Cursor-Pagination (50 Default, 200 Max). Filter per Query-Param inkl. Datum + Custom-Felder. Sortierung. Sparse Fieldsets. Embedded Relations Tiefe 1. Auto-OpenAPI-Spec unter /api/v1/openapi.json. Swagger-UI mit „Try it out". Versionierung URL-basiert mit Deprecation-Phase. Antwort-Format {data, meta} / {error: {code, message, details}}. Klartext-Fehler in DE.

Pflichtenheft-Bezug

  • 34.1 — Read-API-Spezifika
  • 34.4 — Anti-Liste (kein Schreib-API, kein GraphQL, kein OAuth2-Provider, kein Bulk-Export)

Abhängigkeiten

  • Vorbedingung: M027 (API-Keys), Daten-Module M042-M074
  • Wird benötigt von: M162, M163

Out of Scope

  • POST/PUT/PATCH/DELETE → Phase 2 (Anti-Liste 34.4.1, V.3.2.13)
  • GraphQL → Anti-Liste V.3.2.14
  • OAuth2-Provider → Anti-Liste V.3.2.15
  • Bulk-Export → Vollexport via M158-M160

Erfolgskriterium

Externer Client liest 50 Kontakte mit Cursor-Pagination; OpenAPI-Spec validiert; Tenant in Frozen-Status → 402 für Schreib (gibt's eh nicht), Lese bleibt.

Hinweise für Slice-Planung

  • Hono-Routes in apps/api
  • swagger-ui-dist (Boilerplate-Deps)
  • Sparse Fieldsets via fields=...-Param

Definition of Done — verbindlich (siehe AGENTS.md + docs/INTEGRATION-CONTRACTS.md)

Dieses Milestone gilt nur dann als erledigt, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.

Erreichbarkeit

  • Sidebar-Eintrag in apps/web/app/application/sidebar/ mit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäß docs/INTEGRATION-CONTRACTS.md §1
  • Route unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
  • Breadcrumb für Detail-Routes (§4)
  • Mobile-Tab-Bar-Eintrag falls mobile-relevant (§13)
  • Customer-Portal-Sichtbarkeit explizit konfiguriert (§14)

Querschnitt-Wiring

  • Audit läuft (auto via M001 oder manuell)
  • Activity-Stream via logActivity bei relevanter Aktion (M045)
  • Notifications via notify() (M011), nicht direkt
  • Search-Index registriert in indexed-entities.ts, falls suchbar
  • Permission-Filter via withTenantScope() + withPermission() (M004)
  • Feature-Flag-fähig (M006) — Modul ohne Deploy abschaltbar

Code-Layer-Disziplin (PR-Block)

  • Loader baut View-Model; UI-Component empfängt nur VM + Actions
  • Keine Prisma-/Server-Imports in packages/ui-app/**
  • Subframe-Output via Adapter, nicht direkt importiert
  • Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)

Tests

  • Unit-Test für VM-Builder mit Zod-Schema-Validierung
  • Smoke-Test e2e/smoke/<modul>.spec.ts (Login → Route → Hauptaktion → erwartetes UI)
  • Hot-Swap-Drill grün (Smoke-Test gegen packages/ui-mock aus M017)
  • Visual-Regression-Snapshot der Hauptansicht (M016)

Klartext (User-facing)

  • Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
  • Empty-State mit Klartext + nächster Aktion
  • Loading-State mit Klartext (kein leerer Spinner)
  • Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)

Rollback-Pfad

  • Forward-Only-DB-Migration mit Inverse-SQL als Kommentar
  • Atomic-Slice-Commits (TC-Default)
  • Feature-Flag vorhanden, um das Modul ohne Deploy auszuschalten

Klick-Pfad zum Prüfen (für User)

Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:

  1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
  2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
  3. Hauptaktion ausführen
  4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)

Falls etwas nicht erreichbar ist: Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.