Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPI aem-content-fragment-delivery-with-openapi
In Adobe Experience Manager (AEM) as a Cloud Service umfasst die AEM OpenAPI für die Bereitstellung von Inhaltsfragmenten Folgendes:
- Sie ist ein OpenAPI, das für die Live-Bereitstellung von AEM-Inhaltsfragmenten im JSON-Format optimiert ist.
- Sie konzentriert sich auf die Bereitstellung von Inhalten (Leistung, Skalierbarkeit, CDN-Integration, optimierte JSON-Steuerung und -Ausgabe).
- Sie umfasst die Möglichkeit, JSON für referenzierte Fragmente und Assets einzubinden.
Diese API:
-
ist die Nachfolgerin der Unterstützung für Inhaltsfragmente in der AEM-Assets-HTTP-API.
-
ergänzt die OpenAPIs mit Inhaltsfragmenten und Inhaltsfragmentmodellen, mit denen Sie die Inhaltsfragmente und Inhaltsfragmentmodelle (CRUD) verwalten können.
-
ist eine HTTP-REST-Alternative zur AEM-GraphQL-API zur Verwendung mit Inhaltsfragmenten.
Die vollständige Dokumentation finden Sie unter Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPI.
- die ID(s) des Cloud Service-Programms und der Umgebung
- Details des Anwendungsfalls, den Sie mit der OpenAPI für die Bereitstellung von Inhaltsfragmenten lösen möchten
- Details zu allen Kontakten, auf die Adobe reagieren sollte, sowie Informationen zu Anfrage und Projekt (falls erforderlich)
Caching caching
AEM integriert sich in das AEM CDN Fastly. Das bedeutet, dass auf der Veröffentlichungsstufe bereitgestellte JSON-Antworten auf der Fastly-Ebene zwischengespeichert werden.
Antworten werden dann zwischengespeichert, basierend auf vordefinierten Zwischenspeicherkopfzeilen (können nicht konfiguriert werden):
- Antworten werden 5 Minuten lang im Browser-/Client-Cache zwischengespeichert.
max-age=300
- Antworten werden 1 Stunde lang im CDN-Cache zwischengespeichert.
s-maxage=3600
- Veraltete Inhalte können bei der erneuten Validierung neuer Anforderungen für bis zu 1 Stunde bereitgestellt werden.
stale-while-revalidate=3600
- Veraltete Inhalte können mit einem Fehler bis zu 1 Tag lang bereitgestellt werden.
stale-on-error=86400
Verfügbarkeit availability
Die Bereitstellung von Inhaltsfragmenten mit OpenAPI ist auf der Vorschau- und Veröffentlichungsebene verfügbar. Die OpenAPI stellt Inhaltsfragmente im JSON-Format für die Vorschau und die Live-Bereitstellung bereit.
Für die Vorschau ermöglicht die Bereitstellung von Inhaltsfragmenten mit OpenAPI Folgendes:
- Veröffentlichen in der Vorschau
- Aktivieren des Zugriffs auf die Vorschau mit einer IP-Zulassungsliste
- Abrufen der Vorschau-URL
CORS cors
Zulässige CORS-Ursprünge definieren die Ursprünge, die das API aufrufen können.
Die auf der Dispatcher-Konfigurationsseite definierten zulässigen CORS-Ursprünge, speziell für GraphQL, werden von diesem API nicht berücksichtigt.
API-Ratenbegrenzung api-rate-limits
Das API ermöglicht neue Anfragen mit einer Rate von bis zu 200 Anfragen pro Sekunde und Umgebung.
Sobald diese Begrenzung überschritten wird, beginnt das API mit dem Senden von 429-Fehlerantworten. Diese Fehler müssen von allen Client-Anwendungen verarbeitet werden, und fehlgeschlagene Anfragen müssen nach einem exponentiellen Backoff-Versuch erneut versucht werden. Die HTTP-Antwort enthält einen bestimmten Header, Retry-After, der dem Client angibt, wie lange er warten muss, bevor er die Anfrage erneut sendet.
Authentifizierte Anfragen authenticated-requests
Die Unterstützung für authentifizierte Anfragen kann mit dem AEM-CDN-Edge-Schlüssel implementiert werden. Durch die Verwendung des AEM-CDN-Edge-Schlüssels können Sie sich auf das AEM-CDN verlassen und sicherstellen, dass nur bestimmte Anfragen basierend auf dem bereitgestellten Edge-Schlüssel-Header auf die API zugreifen können.
Bereitstellen eines zusammengesetzten Elements deliver-a-composite-item
Sie können Ihre zusammengesetzten Elemente mit den folgenden APIs bereitstellen:
-
Über die Management OpenAPI (Inhaltsfragmentverwaltungs-API)
-
die REST-Bereitstellungs-API. Es gibt zwei Pfade:
- Zur Veröffentlichungszeit vorgebacken
- In-Prozess-Versand von AEM
-
Bei OpenAPI-Antworten, die hydrierte referenzierte Fragmente enthalten, können Zusammensetzungen den Overhead von Referenz- und Fragmentmetadaten reduzieren. Die Payload-Größe hängt von der Inhaltsstruktur und den Optionen zum Einschließen von Verweisen ab. Eingebettete zusammengesetzte Inhalte werden unabhängig von der Referenztiefe einbezogen, sodass flache Antworten größer sein können als entsprechende referenzbasierte Antworten.