Seminar KrakenD – API-Komposition und Datentransformation

Inhaltsübersicht

1. Seminarprofil
2. Lernziele
3. Zielgruppe
4. Voraussetzungen
5. Seminarinhalte
6. Praxisübungen
7. Technische Arbeitsumgebung

Seminarprofil

Das Seminar konzentriert sich auf den Kernnutzen eines deklarativen API Gateways: mehrere Backends zu einer stabilen Client-API zusammenzuführen, interne Strukturen zu verbergen und Daten ohne zusätzlichen Anwendungsservice gezielt aufzubereiten.

Behandelt werden parallele Backendaufrufe, Aggregation, Filterung, Mapping, Collection-Verarbeitung, statische Ergänzungen, Fehlerstrategien und Ausgabeformate. Ein durchgehendes Backend-for-Frontend-Beispiel zeigt die Auswirkungen jeder Konfigurationsentscheidung.

Lernziele

• Endpoint- und Backendverträge sauber voneinander trennen
• mehrere Backendantworten parallel und deterministisch aggregieren
• Objekte und Collections mit geeigneten Operatoren filtern, verschieben und umbenennen
• Header, Query-Parameter, Pfadparameter und Nutzdaten kontrolliert weitergeben
• Statuscodes, Fehlerdetails und Ausgabeformate bewusst gestalten
• eine wartbare Backend-for-Frontend-Konfiguration aufbauen und testen

Zielgruppe

API-Entwicklung, Backend-Entwicklung, Plattformteams, Integrationsarchitektur und technische Qualitätssicherung.

Voraussetzungen

Gute Kenntnisse in HTTP und JSON. Erste Erfahrungen mit REST-APIs und Kommandozeilenwerkzeugen werden vorausgesetzt.

Seminarinhalte

1. API-Vertrag und Ausführungsfluss

Eine belastbare Komposition beginnt mit einem klaren externen Vertrag und einer bewussten Entkopplung der internen Dienste.

1. Schritt 1: Clientanforderungen als Endpointvertrag mit Methode, Pfad, Parametern und Ausgabeformat erfassen.
2. Schritt 2: Interne Backendpfade, Hosts und Methoden getrennt vom öffentlichen Vertrag definieren.
3. Schritt 3: Den Ausführungsfluss vom Router über Proxy und Backend bis zur Antwort nachvollziehen.
4. Schritt 4: Mit einer Minimalroute prüfen, welche Header und Parameter tatsächlich verarbeitet werden.

2. Parallele Aggregation mehrerer Backends

KrakenD kann unabhängige Datenquellen parallel aufrufen und deren Ergebnisse zu einer Antwort verbinden.

1. Schritt 1: Unabhängige Backendaufrufe identifizieren und als getrennte Backendobjekte konfigurieren.
2. Schritt 2: Namenskollisionen vermeiden, indem Antworten vor der Aggregation in eindeutige Zielobjekte verschoben werden.
3. Schritt 3: Zeitgrenzen und Fehlerverhalten je Datenquelle so wählen, dass ein langsamer Dienst nicht die gesamte API dominiert.
4. Schritt 4: Vollständige und teilweise Antworten mit reproduzierbaren Fehlerfällen testen.

3. Objektmanipulation und Feldkontrolle

Die externe API soll nur die Daten enthalten, die für den jeweiligen Clientvertrag erforderlich sind.

1. Schritt 1: Erlaubte oder gesperrte Felder anhand des gewünschten Vertrages festlegen.
2. Schritt 2: Felder umbenennen und verschachtelte Objekte gezielt an eine andere Position verschieben.
3. Schritt 3: Statische Werte für Versionen, Kennzeichen oder Ersatzdaten ergänzen.
4. Schritt 4: Mit Vertragsbeispielen prüfen, dass interne Felder und sensible Daten nicht durchgereicht werden.

4. Collections und komplexe Transformationen

Arrays erfordern andere Bearbeitungsregeln als einfache JSON-Objekte und müssen hinsichtlich Reihenfolge und Struktur getestet werden.

1. Schritt 1: Collection-Antworten erkennen und ein geeignetes Ausgabeformat wählen.
2. Schritt 2: Elemente filtern, verschieben, flach abbilden oder in neue Strukturen überführen.
3. Schritt 3: Rechenintensive Transformationen nur dort einsetzen, wo einfachere Operatoren nicht ausreichen.
4. Schritt 4: Große Collections mit realistischen Nutzdaten auf Laufzeit und Speicherbedarf prüfen.

5. Request-Manipulation und Parameterweitergabe

Eingehende Daten werden ausdrücklich freigegeben, transformiert oder ergänzt, bevor sie interne Dienste erreichen.

1. Schritt 1: Benötigte Header und Query-Parameter in Positivlisten aufnehmen.
2. Schritt 2: Pfadparameter korrekt auf Backendpfade abbilden und Groß-/Kleinschreibung prüfen.
3. Schritt 3: Statische Header oder Backendwerte ergänzen, ohne Geheimnisse in der Konfiguration offenzulegen.
4. Schritt 4: Fehlende, doppelte und unerlaubte Parameter mit Negativtests absichern.

6. Formate, Statuscodes und Fehlerstrategien

Ausgabeformat und Fehlerpolitik bestimmen, wie stark Clients von internen Diensten entkoppelt bleiben.

1. Schritt 1: JSON-, Collection-, String- und No-Op-Verarbeitung passend zum Backendverhalten auswählen.
2. Schritt 2: Entscheiden, ob Backendstatuscodes unverändert, normalisiert oder bewusst verborgen werden.
3. Schritt 3: Detaillierte Backendfehler nur in kontrollierten Fällen freigeben.
4. Schritt 4: Vertragstests für Erfolg, Teilfehler, Zeitüberschreitung und ungültige Nutzdaten ausführen.

7. Backend-for-Frontend als Gesamtübung

Zum Abschluss entsteht eine kompakte API für einen konkreten Client, die mehrere interne Dienste kapselt.

1. Schritt 1: Benötigte Bildschirmdaten in einen externen Vertrag überführen.
2. Schritt 2: Backendaufrufe, Aggregation und Feldtransformation schrittweise konfigurieren.
3. Schritt 3: Fehlerfälle und unvollständige Daten mit definierten Regeln behandeln.
4. Schritt 4: Konfiguration prüfen, automatisierte Tests ausführen und Änderungen versionierbar ablegen.

Praxisübungen

• Aggregation von Produkt-, Preis- und Verfügbarkeitsdaten
• Umbenennen und Filtern verschachtelter Antwortfelder
• Transformation einer Collection mit Flatmap-Operationen
• Kontrollierte Weitergabe von Headern und Query-Parametern
• Vertragstests für vollständige, teilweise und fehlerhafte Antworten

Technische Arbeitsumgebung

Benötigt werden Docker, ein JSON-fähiger Editor, ein API-Client und lokale Beispieldienste. Alle Übungen arbeiten mit versionierten Konfigurationsdateien und wiederholbaren Testaufrufen.