AEM GraphQL-API zur Verwendung mit Inhaltsfragmenten graphql-api-for-use-with-content-fragments
Erfahren Sie, wie Sie Inhaltsfragmente in Adobe Experience Manager (AEM) as a Cloud Service mit der AEM GraphQL-API für die Headless-Bereitstellung von Inhalten verwenden.
Die mit Inhaltsfragmenten verwendete GraphQL-API von AEM as a Cloud Service basiert stark auf der standardmäßigen Open-Source-GraphQL-API.
Die Verwendung der GraphQL-API in AEM ermöglicht die effiziente Bereitstellung von Inhaltsfragmenten an JavaScript-Clients in Headless CMS-Implementierungen:
- Vermeiden von iterativen API-Anfragen wie bei REST,
- Sicherstellen, dass die Bereitstellung auf die spezifischen Anforderungen beschränkt ist,
- Ermöglichen der Massenbereitstellung von genau dem, was zum Rendern als Antwort auf eine einzelne API-Anfrage benötigt wird.
- AEM Commerce nutzt Daten von einer Commerce-Plattform über GraphQL.
- AEM-Inhaltsfragmente stellen in Kombination mit der AEM-GraphQL-API (einer auf GraphQL basierenden benutzerdefinierten Implementierung) strukturierte Inhalte für die Verwendung in Ihren Programmen bereit.
Die GraphQL-API graphql-api
GraphQL ist:
-
„…eine Abfragesprache für APIs und eine Laufzeitumgebung zur Erfüllung dieser Abfragen mit Ihren vorhandenen Daten. GraphQL bietet eine vollständige und verständliche Beschreibung der Daten in Ihrer API, gibt Kunden die Möglichkeit, genau das abzufragen, was sie benötigen, und nicht mehr, macht es einfacher, APIs im Laufe der Zeit weiterzuentwickeln, und ermöglicht leistungsstarke Entwicklerwerkzeuge.“
Weitere Informationen finden Sie unter GraphQL.org
-
„…eine offene Spezifikation für eine flexible API-Schicht. Legen Sie GraphQL über Ihre bestehenden Backends, um Produkte schneller als je zuvor zu erstellen …“
Weitere Informationen finden Sie unter GraphQL entdecken.
-
„… eine Datenabfragesprache und -spezifikation, die 2012 intern von Facebook entwickelt wurde, bevor sie 2015 öffentlich als Open Source zur Verfügung gestellt wurde. Sie bietet eine Alternative zu REST-basierten Architekturen mit dem Ziel, die Produktivität von Entwicklern zu erhöhen und die Menge der übertragenen Daten zu minimieren. GraphQL wird von Hunderten von Unternehmen aller Größenordnungen in der Produktion eingesetzt …“
Siehe GraphQL Foundation.
Weitere Informationen zur GraphQL-API finden Sie in den folgenden Abschnitten (neben vielen anderen Ressourcen):
Die Implementierung von GraphQL für AEM basiert auf der standardmäßigen GraphQL-Java-Bibliothek. Siehe:
GraphQL-Terminologie graphql-terminology
GraphQL verwendet Folgendes:
-
- Schemata werden von AEM basierend auf den Inhaltsfragmentmodellen generiert.
- GraphQL stellt mithilfe Ihrer Schemata die Typen und Vorgänge dar, die für die GraphQL-Implementierung für AEM zulässig sind.
-
-
Der Pfad in AEM, der auf GraphQL-Abfragen antwortet und Zugriff auf die GraphQL-Schemata bietet.
-
Weitere Informationen finden Sie unter Aktivieren des GraphQL-Endpunkts.
-
In der (GraphQL.org) Einführung in GraphQL finden Sie ausführliche Informationen, einschließlich der Best Practices.
GraphQL-Abfragetypen graphql-query-types
Mit GraphQL können Sie Abfragen für Folgendes durchführen:
-
Einen einzelnen Eintrag
-
Eine Liste von Einträgen
AEM bietet Funktionen zum Konvertieren von Abfragen (beide Typen) in persistente Abfragen, die vom Dispatcher und CDN zwischengespeichert werden können.
Best Practices für GraphQL-Abfragen (Dispatcher und CDN) graphql-query-best-practices
Die persistenten Abfragen sind die empfohlene Methode für die Nutzung bei Veröffentlichungsinstanzen, da:
- sie zwischengespeichert werden
- sie zentral von AEM as a Cloud Service verwaltet werden
GraphQL-Abfragen über POST werden nicht empfohlen, da sie nicht zwischengespeichert werden. Daher ist der Dispatcher auf einer Standardinstanz so konfiguriert, dass er solche Abfragen blockiert.
GraphQL unterstützt zwar auch GET-Anfragen, diese können jedoch Einschränkungen unterliegen (z. B. die Länge der URL), die durch die Verwendung persistierter Abfragen vermieden werden können.
Weitere Informationen finden Sie unter Aktivieren der Caching-Funktion für persistierte Abfragen.
- Eine Cloud Manager-Umgebungsvariable mit dem Namen
ENABLE_GRAPHQL_ENDPOINT - und dem Wert
trueerstellen
GraphiQL-IDE graphiql-ide
Zusätzlich können Sie GraphQL-Abfragen mit der GraphiQL-IDE testen und debuggen.
Anwendungsfälle für Autoren und Autorinnen, Vorschau und Veröffentlichung use-cases-author-preview-publish
Die Anwendungsfälle können vom Typ der AEM as a Cloud Service-Umgebung abhängig sein:
-
Veröffentlichungsumgebung; wird verwendet, um:
- Daten für das JS-Programm (Standardanwendungsfall) abzufragen
-
Vorschauumgebung; wird verwendet, um:
- eine Vorschau der Abfragen vor der Bereitstellung in der Publishing-Umgebung anzuzeigen
- Daten für das JS-Programm (Standardanwendungsfall) abzufragen
- eine Vorschau der Abfragen vor der Bereitstellung in der Publishing-Umgebung anzuzeigen
-
Autorenumgebung; wird verwendet, um:
-
Daten für „Content-Management-Zwecke“ abzufragen:
- GraphQL in AEM as a Cloud Service ist derzeit eine schreibgeschützte API.
- Die REST-API kann für CR(u)D-Vorgänge verwendet werden.
-
Berechtigungen permission
Die Berechtigungen sind diejenigen, die für den Zugriff auf Assets erforderlich sind.
GraphQL-Abfragen werden mit der Berechtigung der AEM-Benutzenden der zugrunde liegenden Anfrage ausgeführt. Wenn die Benutzenden keinen Lesezugriff auf einige (als Assets gespeicherte) Fragmente haben, werden diese nicht Teil der Ergebnismenge.
Außerdem benötigen die Benutzenden Zugriff auf einen GraphQL-Endpunkt, um GraphQL-Abfragen ausführen zu können.
Schema-Generierung schema-generation
GraphQL ist eine stark typisierte API, was bedeutet, dass die Daten klar strukturiert und nach Typ geordnet sein müssen.
Die GraphQL-Spezifikation enthält eine Reihe von Richtlinien zum Erstellen einer robusten API zum Abfragen von Daten in einer bestimmten Instanz. Dazu muss ein Client das Schema abrufen, das alle für eine Abfrage erforderlichen Typen enthält.
Bei Inhaltsfragmenten basieren die GraphQL-Schemata (Struktur und Typen) auf aktivierten Inhaltsfragmentmodellen und deren Datentypen.
Wenn Benutzende beispielsweise ein Inhaltsfragmentmodell mit dem Namen Article erstellen, generiert AEM den GraphQL-Typ ArticleModel. Die Felder dieses Typs entsprechen den im Modell definierten Feldern und Datentypen. Außerdem werden einige Einstiegspunkte für Abfragen erstellt, die für diesen Typ gelten, z. B. articleByPath oder articleList.
-
Ein Inhaltsfragmentmodell:
-
Das entsprechende GraphQL-Schema (Ausgabe aus der automatischen GraphiQL-Dokumentation):
Dies zeigt, dass der generierte Typ
ArticleModelmehrere Felder enthält.-
Drei davon wurden vom Benutzer kontrolliert:
author,mainundreferencearticle. -
Die anderen Felder wurden automatisch von AEM hinzugefügt und helfen, Informationen zu einem bestimmten Inhaltsfragment bereitzustellen. In diesem Beispiel (die Hilfsfelder)
_path,_metadataund_variations.
-
-
Nachdem ein Benutzer ein Inhaltsfragment basierend auf dem Modell „Article“ erstellt hat, kann es über GraphQL abgefragt werden. Beispiele finden Sie in den Beispielabfragen (basierend auf einer Beispielstruktur für Inhaltsfragmente zur Verwendung mit GraphQL).
In GraphQL für AEM ist das Schema flexibel. Dies bedeutet, dass es jedes Mal automatisch generiert wird, wenn ein Inhaltsfragmentmodell erstellt, aktualisiert oder gelöscht wird. Die Datenschema-Caches werden auch aktualisiert, wenn Sie ein Inhaltsfragmentmodell aktualisieren.
Die Datenschema-Caches werden auch aktualisiert, wenn Sie ein Inhaltsfragmentmodell aktualisieren.
Der Sites GraphQL-Service überwacht (im Hintergrund) alle Änderungen, die an einem Inhaltsfragmentmodell vorgenommen werden. Wenn Aktualisierungen erkannt werden, wird nur dieser Teil des Schemas neu generiert. Diese Optimierung spart Zeit und sorgt für Stabilität.
Wenn Sie zum Beispiel:
-
ein Paket installieren, das
Content-Fragment-Model-1undContent-Fragment-Model-2enthält:- GraphQL-Typen werden für
Model-1undModel-2generiert.
- GraphQL-Typen werden für
-
Ändern Sie anschließend
Content-Fragment-Model-2:-
Nur der GraphQL-Typ
Model-2wird aktualisiert. -
Model-1bleibt unverändert.
-
Das Schema wird über denselben Endpunkt wie die GraphQL-Abfragen bereitgestellt, wobei der Client die Tatsache behandelt, dass das Schema mit der GQLschema-Erweiterung aufgerufen wird. Wenn Sie beispielsweise eine einfache GET-Anfrage an /content/cq:graphql/global/endpoint.GQLschema ausführen, wird das Schema mit dem Inhaltstyp ausgegeben: text/x-graphql-schema;charset=iso-8859-1.
Schemagenerierung – Nicht veröffentlichte Modelle schema-generation-unpublished-models
Wenn Inhaltsfragmente verschachtelt sind, kann es vorkommen, dass ein übergeordnetes Inhaltsfragmentmodell veröffentlicht wird, ein referenziertes Modell jedoch nicht.
In diesem Fall generiert AEM ein unvollständiges Schema für das übergeordnete Inhaltsfragmentmodell. Das bedeutet, dass die Fragmentreferenz, die vom nicht veröffentlichten Modell abhängt, aus dem Schema entfernt wird.
Felder fields
Innerhalb des Schemas gibt es einzelne Felder, die zwei grundlegenden Kategorien angehören:
-
Von Ihnen generierte Felder.
Eine Auswahl von Datentypen wird verwendet, um Felder basierend auf der Konfiguration Ihres Inhaltsfragmentmodells zu erstellen. Die Feldnamen werden dem Feld Eigenschaftsname auf der Registerkarte Datentyp entnommen.
- Daneben gibt es auch die Einstellung Rendern als, da Benutzende bestimmte Datentypen konfigurieren können. Beispielsweise kann ein einzeiliges Textfeld so konfiguriert werden, dass es mehrere einzeilige Texte enthält, indem
multifieldaus der Dropdown-Liste ausgewählt wird.
- Daneben gibt es auch die Einstellung Rendern als, da Benutzende bestimmte Datentypen konfigurieren können. Beispielsweise kann ein einzeiliges Textfeld so konfiguriert werden, dass es mehrere einzeilige Texte enthält, indem
-
GraphQL für AEM generiert auch eine Reihe von Hilfsfeldern.
Datentypen data-types
GraphQL für AEM unterstützt eine Liste von Typen. Alle unterstützten Datentypen für Inhaltsfragmentmodelle und die entsprechenden GraphQL-Typen werden dargestellt:
String, [String]String, [String]Float, [Float]BooleanCalendaronlyDate, onlyTime, dateTimeString[String]String, [String]String, [String]Einzelnes Feld:
Model – Modelltyp, direkt referenziertMultifeld, mit einem referenzierten Typ:
[Model]: Array vom Typ Model, direkt referenziert von ArrayMultifeld, mit mehreren referenzierten Typen:
[AllFragmentModels]: Array aller Modelltypen, referenziert von Array mit VereinigungstypEinzelnes Feld:
Model – Modelltyp, direkt referenziertMultifeld, mit einem referenzierten Typ:
[Model]: Array vom Typ Model, direkt referenziert von ArrayMultifeld, mit mehreren referenzierten Typen:
[AllFragmentModels]: Array aller Modelltypen, referenziert von Array mit VereinigungstypHilfsfelder helper-fields
Zusätzlich zu den Datentypen für benutzergenerierte Felder generiert GraphQL für AEM auch mehrere Hilfsfelder, um ein Inhaltsfragment zu identifizieren oder zusätzliche Informationen über ein Inhaltsfragment bereitzustellen.
Diese Hilfsfelder sind durch ein vorangestelltes _ gekennzeichnet, um zu unterscheiden, was vom Benutzer bzw. von der Benutzerin definiert und was automatisch generiert wurde.
Pfad path
Das Pfadfeld wird in AEM GraphQL als Kennung verwendet. Es stellt den Pfad des Inhaltsfragment-Assets im AEM Repository dar. Wir haben es als Kennung für ein Inhaltsfragment ausgewählt, da es:
- innerhalb von AEM eindeutig ist,
- leicht abgerufen werden kann.
Der folgende Code zeigt die Pfade aller Inhaltsfragmente an, die auf der Grundlage des Inhaltsfragmentmodells Author erstellt wurden, das im WKND-Tutorial vorgestellt wurde.
{
authorList {
items {
_path
}
}
}
Um ein einzelnes Inhaltsfragment eines bestimmten Typs abzurufen, müssen Sie zuerst dessen Pfad bestimmen. Zum Beispiel:
{
authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
item {
_path
firstName
lastName
}
}
}
Siehe Beispielabfrage – ein Einzelstadtfragment.
ID (UUID) id-uuid
Das ID-Feld wird auch in AEM GraphQL als Identifikator verwendet. Sie stellt den Pfad des Inhaltsfragment-Assets innerhalb des AEM-Repositorys dar, enthält jedoch nicht den tatsächlichen Pfad, sondern eine UUID, die die Ressource darstellt. Wir haben es als Kennung für ein Inhaltsfragment ausgewählt, da es:
- innerhalb von AEM eindeutig ist,
- leicht abgerufen werden können,
- ändert sich nicht, wenn die Ressource verschoben wird.
Die UUID für ein Inhaltsfragment und für ein referenziertes Inhaltsfragment oder Asset kann über die JSON-Eigenschaft _id zurückgegeben werden.
{
articleList {
items {
_id
_path
}
}
}
Metadaten metadata
Mit GraphQL stellt AEM auch die Metadaten eines Inhaltsfragments zur Verfügung. Metadaten sind die Informationen, die ein Inhaltsfragment beschreiben, z. B. der Titel eines Inhaltsfragments, der Miniaturbildpfad, die Beschreibung eines Inhaltsfragments, das Erstellungsdatum usw.
Da Metadaten über den Schema-Editor generiert werden und daher keine bestimmte Struktur haben, wurde der GraphQL-Typ TypedMetaData implementiert, um die Metadaten eines Inhaltsfragments anzuzeigen. TypedMetaData stellt die Informationen gruppiert nach den folgenden Skalartypen bereit:
stringMetadata:[StringMetadata]!stringArrayMetadata:[StringArrayMetadata]!intMetadata:[IntMetadata]!intArrayMetadata:[IntArrayMetadata]!floatMetadata:[FloatMetadata]!floatArrayMetadata:[FloatArrayMetadata]!booleanMetadata:[BooleanMetadata]!booleanArrayMetadata:[booleanArrayMetadata]!calendarMetadata:[CalendarMetadata]!calendarArrayMetadata:[CalendarArrayMetadata]!Jeder Skalartyp repräsentiert entweder ein einzelnes Name-Wert-Paar oder ein Array von Name-Wert-Paaren, wobei der Wert dieses Paares dem Typ entspricht, in dem er gruppiert wurde.
Wenn Sie beispielsweise den Titel eines Inhaltsfragments abrufen möchten, wissen wir, dass diese Eigenschaft eine Zeichenfolgeneigenschaft ist. Daher würden wir eine Abfrage für alle Zeichenfolgenmetadaten durchführen:
Abfragen von Metadaten:
{
authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
item {
_metadata {
stringMetadata {
name
value
}
}
}
}
}
Sie können alle GraphQL-Typen für Metadaten anzeigen, wenn Sie das generierte GraphQL-Schema anzeigen. Alle Modelltypen haben dieselben TypedMetaData.
Beachten Sie, dass sich
StringMetadata und StringArrayMetadata beide auf das beziehen, was im Repository gespeichert ist, und nicht darauf, wie Sie sie abrufen.stringMetadata aufrufen, erhalten Sie ein Array aller im Repository gespeicherten Metadaten als String und wenn Sie stringArrayMetadata aufrufen, erhalten Sie ein Array aller Metadaten, die im Repository als String[] gespeichert wurden.Weitere Informationen finden Sie unter Beispielabfrage für Metadaten – Liste der Metadaten für Auszeichnungen mit dem Titel „GB“.
Varianten variations
Das Feld _variations wurde implementiert, um die Abfrage der Varianten eines Inhaltsfragments zu vereinfachen. Zum Beispiel:
{
authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo") {
item {
_variations
}
}
}
_variations enthält keine master-Varianten, weil die Originaldaten (in der Benutzeroberfläche als Master referenziert) technisch gesehen nicht als explizite Varianten betrachtet werden.Weitere Informationen finden Sie unter Beispielabfrage – Alle Städte mit einer gegebenen Variante.
GraphQL-Variablen graphql-variables
Mit GraphQL können Variablen in die Abfrage eingefügt werden. Weitere Informationen finden Sie in der GraphQL-Dokumentation für Variablen.
Um beispielsweise alle Inhaltsfragmente des Typs Author in einer bestimmten Variante abzurufen (falls verfügbar), können Sie in GraphiQL das Argument variation angeben.
Abfrage:
query($variation: String!) {
authorList(variation: $variation) {
items {
_variation
lastName
firstName
}
}
}
Abfragevariablen:
{
"variation": "another"
}
Diese Abfrage gibt die vollständige Autorenliste zurück. Autorinnen und Autoren ohne die Variante another greifen auf die Originaldaten zurück (_variation meldet in diesem Fall master).
Wenden Sie einen Filter an, wenn Sie die Liste auf Autorinnen und Autoren beschränken möchten, die die angegebene Variante bereitstellen (und Autorinnen und Autoren überspringen möchten, die auf die Originaldaten zurückgreifen würden):
query($variation: String!) {
authorList(variation: $variation, filter: {
_variation: {
_expressions: {
value: $variation
}
}
}) {
items {
_variation
lastName
firstName
}
}
}
GraphQL-Anweisungen graphql-directives
In GraphQL besteht die Möglichkeit, die Abfrage basierend auf Variablen zu ändern, die als GraphQL-Anweisungen bezeichnet werden.
Sie können beispielsweise das Feld adventurePrice basierend auf einer Variablen includePrice in eine Abfrage für alle AdventureModels einfügen.
Abfrage:
query GetAdventureByType($includePrice: Boolean!) {
adventureList {
items {
title
price @include(if: $includePrice)
}
}
}
Abfragevariablen:
{
"includePrice": true
}
Filtern filtering
Sie können auch Filterung in Ihren GraphQL-Abfragen verwenden, um bestimmte Daten zurückzugeben.
Beim Filtern wird eine Syntax verwendet, die auf logischen Operatoren und Ausdrücken basiert.
Der kleinste Teil ist ein einzelner Ausdruck, der auf den Inhalt eines bestimmten Felds angewendet werden kann. Er vergleicht den Inhalt des Felds mit einem gegebenen konstanten Wert.
Beispielsweise würde der Ausdruck
{
value: "some text"
_op: EQUALS
}
den Inhalt des Felds mit dem Wert some text vergleichen und wäre erfolgreich, wenn der Inhalt dem Wert entspricht. Andernfalls schlägt der Ausdruck fehl.
Die folgenden Operatoren können verwendet werden, um Felder mit einem bestimmten Wert zu vergleichen:
EQUALSString, ID, BooleanEQUALS_NOTString, IDCONTAINSString{ value: "mas", _op: CONTAINS } passt zu Christmas, Xmas, master, …)CONTAINS_NOTStringSTARTS_WITHID{ value: "/content/dam/", _op: STARTS_WITH passt zu /content/dam/path/to/fragment, aber nicht zu /namespace/content/dam/something)EQUALInt, FloatUNEQUALInt, FloatGREATERInt, FloatGREATER_EQUALInt, FloatLOWERInt, FloatLOWER_EQUALInt, FloatATCalendar, Date, TimeNOT_ATCalendar, Date, TimeBEFORECalendar, Date, TimeAT_OR_BEFORECalendar, Date, TimeAFTERCalendar, Date, TimeAT_OR_AFTERCalendar, Date, TimeBei einigen Typen können Sie auch zusätzliche Optionen angeben, mithilfe derer die Auswertung eines Ausdrucks geändert werden kann:
_ignoreCaseStringtime entspricht z. B. TIME, time, tImE, …_sensitivenessFloatfloat-Werte, die als identisch betrachtet werden (um technische Einschränkungen aufgrund der internen Darstellung von float-Werten zu umgehen; sollte vermieden werden, da diese Option negative Auswirkungen auf die Leistung haben kannAusdrücke können mithilfe eines logischen Operators (_logOp) zu einer Gruppe kombiniert werden:
OR– die Ausdrucksgruppe ist erfolgreich, wenn mindestens ein Ausdruck erfolgreich istAND– die Ausdrucksgruppe ist erfolgreich, wenn alle Ausdrücke erfolgreich sind (Standard)
Jedes Feld kann anhand einer eigenen Ausdrucksgruppe gefiltert werden. Die Ausdrucksgruppen aller im Filterargument erwähnten Felder werden schließlich durch einen eigenen logischen Operator kombiniert.
Eine Filterdefinition (als das filter-Argument an eine Abfrage übergeben) enthält:
- Eine Unterdefinition für jedes Feld (auf das Feld kann über seinen Namen zugegriffen werden, z. B. gibt es ein
lastName-Feld im Filter für daslastName-Feld im Daten(feld)typ) - Jede Unterdefinition enthält das
_expressions-Array, das die Ausdrucksgruppe bereitstellt, und das_logOp-Feld, das den logischen Operator definiert, mit dem die Ausdrücke kombiniert werden sollten - Jeder Ausdruck wird durch den Wert (
value-Feld) und den Operator (_operator-Feld) definiert, mit dem der Inhalt eines Felds verglichen werden soll
Sie können _logOp auslassen, wenn Sie Elemente mit AND kombinieren wollen, und _operator, wenn Sie auf Gleichheit prüfen wollen, da dies die Standardwerte sind.
Das folgende Beispiel zeigt eine vollständige Abfrage, die alle Personen filtert, die über eine lastName von Provo verfügen oder sjö enthalten, ohne die Groß-/Kleinschreibung zu beachten:
{
authorList(filter: {
lastname: {
_logOp: OR
_expressions: [
{
value: "sjö",
_operator: CONTAINS,
_ignoreCase: true
},
{
value: "Provo"
}
]
}
}) {
items {
lastName
firstName
}
}
}
Sie können zwar auch nach verschachtelten Feldern filtern, dies wird jedoch nicht empfohlen, da es zu Leistungsproblemen führen kann.
Weitere Beispiele finden Sie unter:
-
Details zu den Erweiterungen von GraphQL für AEM
-
Beispielabfragen unter Verwendung dieses Beispielinhalts und dieser Beispielstruktur
- Und Beispielinhalt und -struktur speziell für die Verwendung in Beispielabfragen
Sortieren sorting
Mit dieser Funktion können Sie die Abfrageergebnisse entsprechend einem bestimmten Feld sortieren.
Die Sortierkriterien:
-
ist eine durch Kommas getrennte Liste von Werten, die den Feldpfad darstellen
- das erste Feld in der Liste definiert die primäre Sortierreihenfolge, das zweite Feld wird verwendet, wenn zwei Werte der primären Sortierkriterien gleich sind, das dritte, wenn die ersten beiden Kriterien gleich sind, usw.
- gepunktete Notation, z. B. „field1.subfield.subfield“ usw.
-
mit optionaler Sortierrichtung
- ASC (aufsteigend) oder DESC (absteigend); standardmäßig wird ASC angewendet
- die Richtung kann pro Feld angegeben werden. Dies bedeutet, dass Sie ein Feld in aufsteigender Reihenfolge sortieren können, ein anderes in absteigender Reihenfolge (name, firstName DESC)
Zum Beispiel:
query {
authorList(sort: "lastName, firstName") {
items {
firstName
lastName
}
}
}
Ein weiteres Beispiel:
{
authorList(sort: "lastName DESC, firstName DESC") {
items {
lastName
firstName
}
}
}
Sie können auch ein Feld innerhalb eines verschachtelten Fragments mithilfe des Formats nestedFragmentname.fieldname sortieren.
Zum Beispiel:
query {
articleList(sort: "authorFragment.lastName") {
items {
title
authorFragment {
firstName
lastName
birthDay
}
slug
}
}
}
Paging paging
Mit dieser Funktion können Sie Paging für Abfragetypen durchführen, was eine Liste zurückgibt. Es werden zwei Methoden bereitgestellt:
offsetundlimitin einerList-Abfragefirstundafterin einerPaginated-Abfrage
Listenabfrage – Versatz und Limit list-offset-limit
In einer ...List-Abfrage können Sie offset und limit verwenden, um eine bestimmte Teilmenge der Ergebnisse zurückzugeben:
offset: Gibt den ersten zurückzugebenden Datensatz anlimit: Gibt die maximale Anzahl an zurückzugebenden Datensätzen an
Beispiel für die Ausgabe der Ergebnisseite, die bis zu fünf Artikel enthält, beginnend mit dem fünften Artikel aus der vollständigen Ergebnisliste:
query {
articleList(offset: 5, limit: 5) {
items {
authorFragment {
lastName
firstName
}
}
}
}
-
Für das Paging ist eine stabile Sortierreihenfolge erforderlich, damit es bei mehreren Abfragen, die verschiedene Seiten desselben Ergebnisses anfordern, korrekt funktioniert. Standardmäßig wird der Repository-Pfad jedes Elements des Ergebnissatzes verwendet, um sicherzustellen, dass die Reihenfolge immer gleich ist. Wenn eine andere Sortierreihenfolge verwendet wird und diese Sortierung nicht auf JCR-Abfrageebene durchgeführt werden kann, hat dies negative Auswirkungen auf die Leistung, da der gesamte Ergebnissatz in den Speicher geladen werden muss, bevor die Seiten bestimmt werden können.
-
Je höher der Versatz, desto länger dauert es, die Elemente aus der vollständigen JCR-Abfrageergebnismenge zu überspringen. Eine alternative Lösung für große Ergebnissätze ist die Verwendung der paginierten Abfrage mit der
first- undafter-Methode.
Paginiete Abfrage – „first“ und „after“ paginated-first-after
Der Abfragetyp ...Paginated verwendet die meisten ...List-Abfragetypfunktionen (Filtern, Sortieren), verwendet jedoch anstelle von offset/limit-Argumenten die first/after-Argumente gemäß der Definition in der GraphQL-Cursor-Verbindungsspezifikation. Eine weniger formale Einführung finden Sie in der Einführung in GraphQL.
first: Dienersten zurückzugebenden Elemente.
Der Standardwert lautet50.
Der Maximalwert ist100.after: Der Cursor, der den Anfang der angeforderten Seite bestimmt; zu beachten ist, dass das durch den Cursor dargestellte Element nicht in der Ergebnismenge enthalten ist; der Cursor eines Elements wird durch das Feldcursorderedges-Struktur bestimmt.
Ein Beispiel für die Ausgabe einer Ergebnisseite mit bis zu fünf Abenteuern, beginnend mit dem angegebenen Cursor-Element in der vollständigen Ergebnisliste:
query {
adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
edges {
cursor
node {
title
}
}
pageInfo {
endCursor
hasNextPage
}
}
}
-
Standardmäßig verwendet Paging die UUID des Repository-Knotens, der das Sortierungsfragment darstellt, um sicherzustellen, dass die Reihenfolge der Ergebnisse immer gleich ist. Wenn
sortverwendet wird, wird die UUID implizit genutzt um eine eindeutige Sortierung sicherzustellen, auch für zwei Elemente mit identischen Sortierschlüsseln. -
Aufgrund interner technischer Einschränkungen wird die Leistung beeinträchtigt, wenn die Sortierung und Filterung auf verschachtelte Felder angewendet wird. Es wird daher empfohlen, auf der Stammebene gespeicherte Filter-/Sortierfelder zu verwenden. Dies ist auch die empfohlene Methode, um große paginierte Ergebnismengen abzufragen.
Web-optimierte Bildbereitstellung in GraphQL-Abfragen web-optimized-image-delivery-in-graphql-queries
Mit einer Web-optimierten Bildbereitstellung können Sie eine GraphQL-Abfrage verwenden, um:
-
Anfordern einer URL für ein DAM-Asset-Bild (referenziert durch eine Inhaltsreferenz)
-
Parameter mit der Abfrage zu übergeben, sodass automatisch eine bestimmte Ausgabedarstellung des Bildes generiert und zurückgegeben wird
note note NOTE Die angegebene Ausgabedarstellung wird nicht in AEM Assets gespeichert. Die Ausgabedarstellung wird generiert und für einen kurzen Zeitraum im Cache gespeichert. -
Die URL als Teil der JSON-Bereitstellung zurückzugeben
Sie können AEM verwenden, um:
- Web-optimierte Bildbereitstellung in GraphQL-Abfragen zu übergeben.
Dies bedeutet, dass die Befehle bei der Ausführung der Abfrage auf die gleiche Weise angewendet werden wie URL-Parameter bei GET-Anfragen für diese Bilder.
Auf diese Weise können Sie Bildausgabeformate für die JSON-Bereitstellung dynamisch erstellen, sodass Sie diese Ausgabedarstellungen nicht manuell erstellen und im Repository speichern müssen.
Die Lösung in GraphQL bietet Ihnen folgende Möglichkeiten:
-
Eine URL anfordern: Verwenden Sie
_dynamicUrlfür den VerweisImageRef. -
Parameter übergeben: Fügen Sie
_assetTransformin den Header der Liste ein, in der Ihre Filter definiert sind.
_dynamicUrl: ein DAM-Asset_dmS7Url: ein Dynamic Media-Asset
_dmS7Url null. Siehe Bereitstellung von Dynamic Media-Assets nach URL in GraphQL-Abfragen.Struktur der Umwandlungsanfrage structure-transformation-request
AssetTransform (_assetTransform) wird verwendet, um die URL-Umwandlungsanfragen zu stellen.
Die Struktur und Syntax sind:
-
format: eine Auflistung mit allen unterstützten Formaten durch ihre Erweiterung: GIF, PNG, PNG8, JPG, PJPG, BJPG, WEBP, WEBPLL oder WEBPLY -
seoName: eine Zeichenfolge, die anstelle des Knotennamens als Dateiname verwendet wird -
crop: eine Rahmenunterstruktur, wenn Breite oder Höhe weggelassen wird, wird die Höhe bzw. Breite als derselbe Wert verwendetxOrigin: der x-Ursprung des Rahmens und ist obligatorischyOrigin: der y-Ursprung des Rahmens und ist obligatorischwidth: die Breite des Rahmensheight: die Höhe des Rahmens
-
size: eine Unterstruktur der Dimension, wenn die Breite oder Höhe weggelassen wird, wird die Höhe bzw. Breite als derselbe Wert verwendetwidth: die Breite der Dimensionheight: die Höhe der Dimension
-
rotation: eine Auflistung aller unterstützten Rotationen: R90, R180, R270 -
flip: eine Auflistung von HORIZONTAL, VERTICAL, HORIZONTAL_AND_VERTICAL -
quality: eine Ganzzahl zwischen 1 und 100, die den Prozentsatz der Bildqualität angibt -
width: eine Ganzzahl, die die Breite des Ausgabebilds definiert, aber vom Bildgenerator ignoriert wird -
preferWebp: ein boolescher Wert, der anzeigt, ob WebP bevorzugt wird (Standardwert ist „false“)
Die URL-Umwandlung ist für alle Abfragetypen verfügbar: nach Pfad, Liste oder mit Paginierung.
Web-optimierte Bildbereitstellung mit vollständigen Parametern web-optimized-image-delivery-full-parameters
Im Folgenden finden Sie eine Beispielabfrage mit einem vollständigen Satz von Parametern:
{
articleList(
_assetTransform: {
format:GIF
seoName:"test"
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
Web-optimierte Bildbereitstellung mit einer einzelnen Abfragevariable web-optimized-image-delivery-single-query-variable
Das folgende Beispiel zeigt die Verwendung einer einzelnen Abfragevariable:
query ($seoName: String!) {
articleList(
_assetTransform: {
format:GIF
seoName:$seoName
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
Web-optimierte Bildbereitstellung mit mehreren Abfragevariablen web-optimized-image-delivery-multiple-query-variables
Das folgende Beispiel zeigt die Verwendung mehrerer Abfragevariablen:
query ($seoName: String!, $format: AssetTransformFormat!) {
articleList(
_assetTransform: {
format:$format
seoName:$seoName
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
Web-optimierte Bildbereitstellungsanfrage nach URL web-optimized-image-delivery-request-url
Wenn Sie Ihre Abfrage als persistierte Abfrage speichern (z. B. unter dem Namen dynamic-url-x), können Sie die persistierte Abfrage direkt ausführen.
Verwenden Sie beispielsweise die folgenden URLs, um die vorherigen Beispiele direkt auszuführen (gespeichert als persistierte Abfragen):
-
Einzelner Parameter; Persistierte Abfrage namens
dynamic-url-x-
http://localhost:4502/graphql/execute.json/wknd-shared/dynamic-url-x;seoName=xxxDie Antwort sieht wie folgt aus:
-
-
Mehrere Parameter; Persistierte Abfrage namens
dynamic-
http://localhost:4502/graphql/execute.json/wknd-shared/dynamic;seoName=billiboy;format=GIF;note caution CAUTION Das abschließende ;ist obligatorisch, um die Liste der Parameter sauber zu beenden.
-
Einschränkungen bei der Web-optimierten Bereitstellung von Bildern web-optimized-image-delivery-limitations
Die folgenden Einschränkungen gelten:
-
Modifikatoren, die auf alle Bilder in der Abfrage angewendet werden (globale Parameter)
-
Zwischenspeichern von Kopfzeilen
- Keine Zwischenspeicherung bei Author
- Zwischenspeicherung bei Publish – Alter von maximal 10 Minuten (kann vom Client nicht geändert werden)
Bereitstellung von Dynamic Media-Assets nach URL in GraphQL-Abfragen dynamic-media-asset-delivery-by-url
Mit GraphQL für AEM-Inhaltsfragmente können Sie eine URL für ein AEM Dynamic Media (Scene7)-Asset anfordern (referenziert durch eine Inhaltsreferenz).
Die Lösung in GraphQL bietet Ihnen folgende Möglichkeiten:
-
Verwenden von
_dmS7Urlfür die ReferenzImageRef -
Verwenden von
_dmS7Urlfür mehrere Verweise;ImageRef,MultimediaRefundDocumentRef -
Verwenden von
_dmS7Urlmit der Funktion für das smarte Zuschneiden-
Die Eigenschaft
_smartCropslegt die Konfigurationen für das smarte Zuschneiden offen, die für ein bestimmtes Asset verfügbar sind -
Siehe Beispielabfrage für die Bereitstellung von Dynamic Media-Assets nach URL – mit smartem Zuschneiden
-
dam:scene7File und dam:scene7Domain zu den Metadaten des Assets hinzu, wenn es erstellt wird._dmS7Url: ein Dynamic Media-Asset_dynamicUrl: ein DAM-Asset
_dynamicURL null. Siehe Web-optimierte Bildbereitstellung in GraphQL-Abfragen.Beispielabfrage für die Bereitstellung von Dynamic Media-Assets nach URL – Bildverweis sample-query-dynamic-media-asset-delivery-by-url-imageref
Es folgt eine Beispielabfrage:
- für mehrere Inhaltsfragmente vom Typ
teamundperson, die einenImageRefzurückgeben
query allTeams {
teamList {
items {
_path
title
teamMembers {
fullName
profilePicture {
__typename
... on ImageRef{
_dmS7Url
height
width
}
}
}
}
}
}
Beispielabfrage für die Bereitstellung von Dynamic Media-Assets nach URL – Mehrere Verweise sample-query-dynamic-media-asset-delivery-by-url-multiple-refs
Es folgt eine Beispielabfrage:
- für mehrere Inhaltsfragmente vom Typ
teamundperson, die einenImageRef,MultimediaRefundDocumentRefzurückgeben:
query allTeams {
teamList {
items {
_path
title
teamMembers {
fullName
profilePicture {
__typename
... on ImageRef{
_dmS7Url
height
width
}
}
featureVideo {
__typename
... on MultimediaRef{
_dmS7Url
size
}
}
about-me {
__typename
... on DocumentRef{
_dmS7Url
_path
}
}
}
}
}
}
Beispielabfrage für die Bereitstellung von Dynamic Media-Assets nach URL – mit smartem Zuschneiden sample-query-dynamic-media-asset-delivery-by-url-smart-crop
Es folgt eine Beispielabfrage:
- zum Anzeigen der für die angeforderten Assets verfügbaren Konfigurationen für das smarte Zuschneiden
query allTeams {
teamList {
items {
title
teamMembers {
profilePicture {
... on ImageRef {
height
width
_dmS7Url
_smartCrops {
width
height
name
}
}
}
}
}
}
}
GraphQL für AEM – Zusammenfassung der Erweiterungen graphql-extensions
Die grundlegende Funktionsweise von Abfragen mit GraphQL für AEM entspricht der Standard-GraphQL-Spezifikation. Für GraphQL-Abfragen mit AEM gibt es einige Erweiterungen:
-
Wenn Sie ein einzelnes Ergebnis benötigen:
- Verwenden Sie den Modellnamen; z. B. Stadt
-
Wenn Sie eine Ergebnisliste erwarten:
- Fügen Sie
Listzum Modellnamen hinzu, z. B.cityList - Siehe Beispielabfrage – Alle Informationen zu allen Städten
Sie haben dann folgende Möglichkeiten:
-
ASC: AufsteigendDESC: Absteigend
-
Ergebnisseite zurückgeben mit einer der folgenden Möglichkeiten:
- Fügen Sie
-
Der Filter
includeVariationsist in den AbfragetypenListundPaginatedenthalten. Um Inhaltsfragmentvarianten in den Abfrageergebnissen abzurufen, muss der FilterincludeVariationsauftruefestgelegt sein.note caution CAUTION Der Filter includeVariationsund das vom System generierte Feld_variationkönnen nicht zusammen in derselben Abfragedefinition verwendet werden. -
Wenn Sie ein logisches ODER verwenden möchten:
- Verwenden Sie
_logOp: OR - Beispielabfrage – Alle Personen mit dem Namen „Jobs“ oder „Smith“
- Verwenden Sie
-
Es gibt ebenfalls ein logisches UND, es ist aber (oft) implizit.
-
Sie können Feldnamen abfragen, die den Feldern im Inhaltsfragmentmodell entsprechen.
-
Zusätzlich zu den Feldern aus Ihrem Modell gibt es einige vom System generierte Felder (denen ein Unterstrich vorangestellt ist):
-
Für Inhalte:
-
_locale: Anzeigen der Sprache; basierend auf Language Manager -
_metadata: Anzeigen von Metadaten für Ihr Fragment -
_model: Zulassen von Abfragen nach einem Inhaltsfragmentmodell (Pfad und Titel) -
_path: Der Pfad zu Ihrem Inhaltsfragment im Repository -
_id: die UUID für Ihr Inhaltsfragment im Repository -
_reference: Anzeigen von Verweisen; einschließlich Inline-Verweisen im Rich-Text-Editor -
_variation: Anzeige bestimmter Varianten in Ihrem Inhaltsfragmentnote note NOTE Wenn die angegebene Variante für ein Inhaltsfragment nicht vorhanden, wird standardmäßig die primäre Variante (als Ersatz) zurückgegeben. note caution CAUTION Das systemgenerierte Feld _variationkann nicht zusammen mit dem FilterincludeVariationsverwendet werden.- Weitere Informationen finden Sie unter Beispielabfrage – Alle Städte mit einer gegebenen Variante
-
-
Für die Bildbereitstellung:
-
_authorURL: ist die vollständige URL zum Bild-Asset in AEM Author -
_publishURL: ist die vollständige URL zum Bild-Asset in AEM Publish -
Für die Web-optimierte Bildbereitstellung (von DAM-Assets):
-
_dynamicUrl: die vollständige URL zum Web-optimierten DAM-Asset auf dem VerweisImageRefnote note NOTE _dynamicUrlist die bevorzugte URL für Web-optimierte DAM-Assets und sollte, wann immer möglich, die Verwendung von_path,_authorUrlund_publishUrlersetzen. -
_assetTransform: zur Übergabe von Parametern im Header der Liste, in der Ihre Filter definiert sind -
Siehe:
-
-
_dmS7Url: in derImageRef-Referenz für die Bereitstellung der URL an ein Dynamic Media-Asset
-
-
_tags: um die IDs von Inhaltsfragmenten oder Varianten anzuzeigen, die Tags enthalten (dies ist ein Array voncq:tags-Kennungen).- Siehe Beispielabfrage – Namen aller Städte, die als Städtereisen markiert sind
- Siehe Beispielabfrage für Inhaltsfragmentvarianten eines bestimmten Modells, an die ein bestimmtes Tag angehängt ist
- Siehe Beispielabfrage mit Filtern nach _tags-ID und Ausschließen von Varianten
- Siehe Beispielabfrage mit Filtern nach _tags-ID und Einschließen von Varianten
note note NOTE Tags können auch durch Auflisten der Metadaten eines Inhaltsfragments abgefragt werden. -
Und Operationen:
-
_operator: bestimmte Operatoren anwenden:EQUALS,EQUALS_NOT,GREATER_EQUAL,LOWER,CONTAINS,STARTS_WITH -
_apply: bestimmte Bedingungen anwenden; zum BeispielAT_LEAST_ONCE -
_ignoreCase: Groß-/Kleinschreibung bei der Abfrage ignorieren
-
-
-
GraphQL-Vereinigungstypen werden unterstützt:
- Verwenden Sie
... on
- Verwenden Sie
-
Fallback bei der Abfrage verschachtelter Fragmente:
- Wenn eine bestimmte Variante nicht in einem verschachtelten Fragment vorhanden ist, wird die primäre Variante ausgegeben.
Abfragen des GraphQL-Endpunkts von einer externen Website query-graphql-endpoint-from-external-website
Für den Zugriff auf den GraphQL-Endpunkt über eine externe Website müssen Sie Folgendes konfigurieren:
Authentifizierung authentication
Siehe Authentifizierung für AEM-GraphQL-Remote-Abfragen in Inhaltsfragmenten.
Automatische Tests automated-testing
Beim Ausführen einer Bereitstellungs-Pipeline in AEM Cloud Manager werden während der Pipeline-Ausführung automatisierte Tests ausgeführt.
Um genaue Ergebnisse zu erzielen, sollte Ihre AEM as a Cloud Service-Staging-Umgebung Ihre Produktionsumgebung so gut wie möglich widerspiegeln. Dies ist insbesondere für Inhalte wichtig.
Sie können dies erreichen, indem Sie in AEM as a Cloud Service mit dem Werkzeug zum Kopieren von Inhalten Produktionsinhalte in die Staging-Umgebung kopieren.
Einschränkungen limitations
Zum Schutz vor potenziellen Problemen gibt es Standardbeschränkungen für Abfragen:
- Die Abfrage darf nicht mehr als 1 Million (1024 × 1024) Zeichen enthalten.
- Die Abfrage darf nicht mehr als 15.000 Token enthalten.
- Die Abfrage darf nicht mehr als 200.000 Whitespace-Token enthalten.
Außerdem müssen Sie Folgendes beachten:
-
Es wird ein Feldkonfliktfehler zurückgegeben, wenn Ihre GraphQL-Abfrage Felder mit demselben Namen in zwei (oder mehr) Modellen enthält und die folgenden Bedingungen erfüllt sind:
-
Etwa in folgendem Fall:
- Zwei (oder mehr Modelle) als mögliche Verweise werden verwendet, wenn sie im Inhaltsfragmentverweis als zulässiger Modelltyp definiert sind.
und:
- Diese beiden Modelle haben Felder mit einem gemeinsamen Namen. Das bedeutet, dass in beiden Modellen der gleiche Name vorkommt.
und
- Diese Felder weisen unterschiedliche Datentypen auf.
-
Zum Beispiel:
-
Wenn zwei (oder mehr) Fragmente mit verschiedenen Modellen (z. B.
M1,M2) als mögliche Verweise (Inhaltsverweis oder Fragmentverweis) aus einem anderen Fragment verwendet werden, z. B.Fragment1MultiField/List, -
und diese beiden Fragmente mit verschiedenen Modellen (
M1,M2) Felder mit demselben Namen, aber unterschiedlichen Typen haben.
Beispiel:M1.TitlealsTextM2.TitlealsText/MultiField
-
Dann tritt ein Feldkonfliktfehler auf, wenn die GraphQL-Abfrage das
Title-Feld enthält.
-
-
Häufig gestellte Fragen faqs
Es wurden folgende Fragen aufgeworfen:
-
F: „Wie unterscheidet sich die GraphQL-API für AEM von der Query Builder-API?“
- A:
„Die AEM-GraphQL-API bietet vollständige Kontrolle über die JSON-Ausgabe und ist ein Industriestandard für die Abfrage von Inhalten.
Für die Zukunft plant AEM, in die AEM GraphQL-API zu investieren.“
- A:
Tutorial – Erste Schritte mit AEM Headless und GraphQL tutorial
Suchen Sie nach einem praktischen Tutorial? Lesen Sie das umfassende Tutorial Erste Schritte mit AEM Headless und GraphQL, in dem veranschaulicht wird, wie Inhalte mithilfe der GraphQL-APIs von AEM erstellt und verfügbar gemacht und von einer externen App in einem Headless CMS-Szenario verwendet werden.