Headless und entkoppelte Frontends #

Diese Seite richtet sich an Entwickler, die das Inhaltsmodell, die Bearbeitung und die Berechtigungen von Exponential hinter einem Frontend nutzen möchten, das mit einem anderen Framework gebaut ist: einer JavaScript-Anwendung, einem Static Site Generator, einer mobilen App oder einer Site, die in Laravel, Django oder Rails geschrieben ist. Exponential ist nicht ausschließlich headless: Es hat eigene Templates, daher entscheiden Sie, wie viel vom Frontend Sie ersetzen (Headless Exponential).

Inhalt #

1. Was Sie behalten und was Sie ersetzen
2. Inhalte lesen
3. Rich Text, Bilder und Links
4. Vorschau
5. Caching und Purging
6. Zuerst hybrid

Was Sie behalten und was Sie ersetzen #

Inhalte lesen #

curl -s -H "Authorization: Bearer $EXP_API_KEY" \
     "https://example.com/api/ezp/v2/content/node/<node id>/list/offset/0/limit/20?ResponseGroups=Metadata,Fields"

Die REST-API verlangt standardmäßig einen Benutzer (rest.ini [Authentication] RequireAuthentication). Verwenden Sie für ein öffentliches Frontend einen Integrationsbenutzer mit reinem Lesezugriff und einer Rolle, die auf das beschränkt ist, was die Site zeigt, und bewahren Sie seinen Schlüssel auf Ihrem Server auf, niemals im Browser-Code (REST- und JSON-APIs).

Rich Text, Bilder und Links #

• OutputFormat=xhtml liefert gerendertes XHTML von Rich-Text-Feldern, sodass das Frontend das interne XML nicht parsen muss.
• Bildfelder enthalten das Original und die Aliase; definieren Sie Aliase für die Größen Ihres Frontends in image.ini (Bilder und Bildvarianten).
• Links in Rich Text zeigen auf Adressen der Site; ordnen Sie sie über den URL-Alias oder die Knoten-ID den Routen Ihres Frontends zu.

Vorschau #

Redakteure sehen die Vorschau in der Administrationsoberfläche mit den Templates der Site. Ein Headless-Frontend braucht eine eigene Vorschau: Lesen Sie die Entwurfsversion über einen authentifizierten Aufruf mit Redakteursrechten und rendern Sie sie in einer geschützten Vorschau-Route. Planen Sie das frühzeitig.

Caching und Purging #

• Das REST-Framework hat einen Antwort-Cache, der in rest.ini konfiguriert wird.
• Cachen Sie in Ihrem Frontend oder CDN; leeren Sie beim Veröffentlichen mit einem Workflow-Ereignis oder einem content/cache-Listener, der den Purge- oder Revalidierungs-Hook Ihres Frontends aufruft (Ereignisse und Listener).
• Holen Sie Listen seitenweise mit Begrenzungen.

Zuerst hybrid #

Viele Projekte belassen die öffentliche Site in den Templates von Exponential und ergänzen eine App oder ein JavaScript-Widget auf Basis der API. So bleiben Vorschau, Layouts, SEO und URL-Aliase einfach, und die App erhält dieselben Inhalte. Gehen Sie ganz auf headless, wenn das Frontend wirklich anderswo leben muss. Wenn das Ziel ein Symfony-Frontend mit Twig auf denselben Inhalten ist, sehen Sie sich statt der REST-API die Legacy Bridge an (Exponential und ein Framework kombinieren).

Verwandte Seiten #

• Headless Exponential
• OAuth und API-Schlüssel
• REST-API v1 und v2
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.