Seminar Enonic XP 8 – Universal APIs, Webapps und Integrationsendpunkte

Das Seminar vermittelt ein einheitliches Entwicklungsmodell für APIs, Webapps und weitere HTTP-Einstiegspunkte in Enonic XP 8. Verträge, Mounting, Sicherheitskontext, Fehlerbehandlung und Betrieb werden gemeinsam entworfen, damit Schnittstellen langfristig wartbar bleiben.

Eine fachliche API mit administrativem und öffentlichem Nutzungskontext wird implementiert. Ergänzend entsteht eine kleine Webapp; Authentifizierung, VHost-Routing, Streaming, Lastgrenzen und automatisierte Vertragstests werden praktisch geprüft.

Inhaltsübersicht

1. Servicearchitektur und API-Vertrag
2. Universal-API-Manifest und Mounting
3. HTTP-Funktionen und Request-Verarbeitung
4. Response- und Fehlerdesign
5. IAM, Service Accounts und Autorisierung
6. Webapps und statische Ressourcen
7. VHosts und Kontextwerte
8. SSE und lange Antworten
9. Versionierung und Clientstabilität
10. Monitoring, Lasttest und Release

Lernziele

• Universal APIs und weitere Servicekontexte korrekt unterscheiden
• HTTP-Funktionen und Verträge robust implementieren
• IAM, Service Accounts und VHosts sicher integrieren
• Webapps und SSE für geeignete Anwendungsfälle einsetzen
• Versionierung, Tests, Monitoring und Deployment operationalisieren

Praxisorientierte Lernschritte

1. Servicearchitektur und API-Vertrag

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: Nutzer, Ressourcen, Operationen und Vertrauensgrenzen erfassen
2. Schritt 2: synchronen Request, Streaming und Hintergrundverarbeitung passend zuordnen
3. Schritt 3: Vertrag für Eingaben, Antworten, Fehler und Versionen formulieren

2. Universal-API-Manifest und Mounting

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: eindeutigen Namen, Beschreibung und Expositionskontext festlegen
2. Schritt 2: API im globalen, administrativen oder Site-Kontext gezielt mounten
3. Schritt 3: erreichbare Pfade und nicht vorgesehene Kontexte mit Tests kontrollieren

3. HTTP-Funktionen und Request-Verarbeitung

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: standardisierte HTTP-Methoden mit klarer Zuständigkeit implementieren
2. Schritt 2: Pfad-, Query-, Header- und Bodydaten validiert verarbeiten
3. Schritt 3: Content-Type, Zeichensatz, Größenlimit und Zeitüberschreitung festlegen

4. Response- und Fehlerdesign

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: Statuscodes und Antwortschema konsistent verwenden
2. Schritt 2: fachliche, technische und sicherheitsbezogene Fehler unterscheiden
3. Schritt 3: Korrelations-ID und sichere Diagnoseinformation für Betrieb ergänzen

5. IAM, Service Accounts und Autorisierung

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: öffentliche, benutzerbezogene und maschinelle Clients unterscheiden
2. Schritt 2: technische Identität mit minimalen Rollen und ACLs ausstatten
3. Schritt 3: jede privilegierte Operation serverseitig mit Negativtests absichern

6. Webapps und statische Ressourcen

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: eigenständigen Webapp-Kontext mit klarer Startseite definieren
2. Schritt 2: Assets, Requests, Filter und Fehlerbehandlung strukturieren
3. Schritt 3: Sitzung, Cache und Zugriff auf Plattformdaten kontrolliert einsetzen

7. VHosts und Kontextwerte

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: Hostnamen, Pfade und externe Domains in Routingregeln abbilden
2. Schritt 2: Projekt, Branch und Principal als VHost-Kontext bewusst setzen
3. Schritt 3: Proxy-Header, Fehlkonfiguration und Hostwechsel praktisch prüfen

8. SSE und lange Antworten

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: Streamingbedarf gegen Polling und WebSocket abgrenzen
2. Schritt 2: SSE-Verbindung mit Ereignisformat, Heartbeat und Abbruch implementieren
3. Schritt 3: Reconnect, Berechtigungswechsel und Ressourcenverbrauch testen

9. Versionierung und Clientstabilität

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: kompatible Erweiterung und breaking Änderung unterscheiden
2. Schritt 2: Deprecation-, Migrations- und Parallelbetriebsstrategie festlegen
3. Schritt 3: Vertragstests mit repräsentativen Clients automatisieren

10. Monitoring, Lasttest und Release

Der Arbeitsblock verbindet fachliche Einordnung, nachvollziehbare Umsetzung und kontrollierte Prüfung. Konfigurationen, Entscheidungen und Prüfergebnisse werden als wiederverwendbare Projektnachweise dokumentiert.

1. Schritt 1: Latenz, Fehler, Durchsatz und Sättigung pro Endpunkt messen
2. Schritt 2: Grenzwerte, Rate-Begrenzung und Überlastverhalten prüfen
3. Schritt 3: Build, Deployment, Smoke Test, Rollback und Betriebsrunbook automatisieren

Zielgruppe und Vorkenntnisse

Zielgruppe: Backend- und Integrationsentwickler, API-Architekten, Enonic-Entwickler, Full-Stack-Teams und technische Leads.

Vorkenntnisse: Sichere Kenntnisse in TypeScript, HTTP, JSON, API-Design und automatisierten Tests sowie Grundkenntnisse des Enonic EDK und des IAM-Modells.

Didaktik und Arbeitsweise

Kurze Fachimpulse werden unmittelbar durch Demonstrationen, strukturierte Konfigurations- oder Implementierungsschritte und kontrollierte Fehlerfälle vertieft. Jede Übung besitzt definierte Ausgangswerte, Prüfpunkte und Dokumentationsanforderungen. Dadurch bleiben die erarbeiteten Abläufe für Projekt- und Betriebsstandards nachvollziehbar.