Seminar Sulu API- und Headless-Integration

Das Seminar zeigt, wie Sulu-Inhalte und projektspezifische Daten über robuste APIs für Webanwendungen, Apps und Integrationsplattformen bereitgestellt werden. Behandelt werden Datenverträge, Sicherheit, Caching, Medien und Tests.

Inhaltsverzeichnis

• Zielgruppe
• Voraussetzungen
• Lernziele
• Lernfelder
• Praxisprojekt Schritt für Schritt
• Qualitätskontrollen
• Empfohlene Anschlussseminare

Zielgruppe

Backend-, Full-Stack- und Integrationsentwickelnde sowie technische Architektinnen und Architekten für entkoppelte Frontends und Systemkopplungen.

Voraussetzungen

Gute PHP- und Symfony-Kenntnisse, Erfahrung mit HTTP und JSON sowie grundlegende Kenntnisse der Sulu-Content-Architektur.

Lernziele

• Headless- und Hybridarchitekturen für Sulu bewerten
• stabile projektspezifische API-Verträge entwerfen
• Content, Medien und eigene Entitäten sicher ausliefern
• Authentifizierung, Autorisierung und Cache-Verhalten abstimmen
• Integrationen mit automatisierten Vertrags- und Funktionstests absichern

Lernfelder

Lerneinheit 1: Integrationsarchitekturen

• Headless, Hybrid Rendering und klassische Website-Ausgabe
• Abgrenzung zwischen öffentlicher Delivery-API und Admin-API
• Verantwortung für Routing, Vorschau und Publikationszustände

Lerneinheit 2: API-Verträge und Ressourcenmodelle

• Ressourcen, Repräsentationen, Versionierung und Fehlermodelle
• Feldselektion, Einbettungen und Beziehungen
• Stabilität, Rückwärtskompatibilität und Änderungsstrategie

Lerneinheit 3: Content auslesen

• Seiten, Artikel, Snippets und Lokalisierungen gezielt laden
• Draft- und Live-Zustände korrekt trennen
• Content-Blöcke in konsistente JSON-Strukturen überführen

Lerneinheit 4: Eigene Controller und Services

• Routen, Controller, Query-Services und Presenter
• Validierung, Serialisierung und HTTP-Statuscodes
• Trennung von Domänenlogik und Transportlogik

Lerneinheit 5: Authentifizierung und Autorisierung

• Öffentliche, anonyme und geschützte Endpunkte
• Security-Kontexte, Rollen und objektbezogene Prüfungen
• Token-Lebenszyklen, Rate-Limits und Missbrauchsschutz

Lerneinheit 6: Medien und URL-Auflösung

• Medienmetadaten, Formate und auslieferbare URLs
• Varianten, Download-Rechte und Cache-Header
• Umgang mit gelöschten, privaten oder noch nicht publizierten Medien

Lerneinheit 7: Caching und Aktualisierung

• HTTP-Caching, ETags und invalidierbare Repräsentationen
• Publikationsereignisse, Nachrichten und Webhooks
• Konsistenz zwischen Content-Änderung und Frontend-Aktualisierung

Lerneinheit 8: Frontend- und App-Anbindung

• Client-seitige Datenmodelle und Fehlerbehandlung
• Navigation, Suche, Pagination und Mehrsprachigkeit
• Vorschaukonzepte für entkoppelte Frontends

Lerneinheit 9: Vertrags- und Integrationstests

• Positive und negative API-Szenarien
• Berechtigungs-, Locale- und Publikationszustände
• Performance-Messung, Testdaten und CI-Ausführung

Praxisprojekt Schritt für Schritt

Als durchgängige Übung entsteht eine versionierte Content-API für eine Webanwendung mit Seiten, Artikeln, Medien, Suche und geschützten Daten.

1. Schritt 1: Ausgangslage, Rollen, Systemgrenzen und Abnahmekriterien für eine versionierte Content-API für eine Webanwendung mit Seiten, Artikeln, Medien, Suche und geschützten Daten festhalten.
2. Schritt 2: Den Lernbereich „Integrationsarchitekturen“ konfigurieren und mit einem Positivfall prüfen.
3. Schritt 3: Den Lernbereich „Content auslesen“ umsetzen und mit realistischen Testdaten verbinden.
4. Schritt 4: Den Lernbereich „Eigene Controller und Services“ durch einen Negativfall und eine Korrektur absichern.
5. Schritt 5: Den Lernbereich „Medien und URL-Auflösung“ analysieren und die benötigten Artefakte festlegen.
6. Schritt 6: Den Lernbereich „Caching und Aktualisierung“ konfigurieren und mit einem Positivfall prüfen.
7. Schritt 7: Den Lernbereich „Vertrags- und Integrationstests“ umsetzen und mit realistischen Testdaten verbinden.
8. Schritt 8: Die Teilkonfigurationen zu einem durchgängigen Anwendungsszenario verbinden und Abhängigkeiten sichtbar dokumentieren.
9. Schritt 9: Berechtigungs-, Locale-, Publikations- und Fehlerfälle mit einer standardisierten Prüfliste ausführen.
10. Schritt 10: Den erreichten Stand als Konfigurationsübersicht, Betriebscheckliste und priorisierte nächste Ausbaustufe festhalten.

Qualitätskontrollen

• Fachliche Anforderungen, Systemgrenzen und Verantwortlichkeiten sind eindeutig dokumentiert.
• Konfigurationen und Implementierungen sind reproduzierbar, versionierbar, vollständig und eigenständig beschrieben.
• Positiv-, Negativ-, Berechtigungs-, Locale- und Fehlerfälle sind nachvollziehbar geprüft.
• Betriebs-, Sicherheits-, Performance- und Wartungsaspekte sind passend zum Thema berücksichtigt.
• Die nächsten Vertiefungsschritte sind nach Risiko und Nutzen priorisiert.

Empfohlene Anschlussseminare

• Sulu Admin-UI entwickeln und anpassen
• Sulu Entwicklung eigener Bundles und Erweiterungen
• Sulu Sicherheit, SSO und Zwei-Faktor-Authentifizierung