AEM GraphQL API för användning med innehållsfragment

Lär dig hur du använder innehållsfragment i Adobe Experience Manager (AEM) as a Cloud Service med AEM GraphQL API för leverans av headless-innehåll.

AEM as a Cloud Service GraphQL-API som används med innehållsfragment är till stor del baserat på GraphQL-API:t med öppen källkod.

Genom att använda GraphQL API i AEM kan du effektivt leverera innehållsfragment till JavaScript-klienter i headless CMS-implementeringar:

• Undvika iterativa API-begäranden som REST,
• se till att leveransen begränsas till de specifika kraven,
• Det går att skicka exakt det som behövs för återgivningen som svar på en enda API-fråga.

GraphQL API

GraphQL är:

• "…ett frågespråk för API:er och en körningsmiljö för att utföra dessa frågor med dina befintliga data. GraphQL ger en fullständig och begriplig beskrivning av data i API:t, ger kunderna möjlighet att fråga efter exakt vad de behöver och ingenting mer, gör det enklare att utveckla API:er över tid och möjliggör kraftfulla utvecklingsverktyg.".

  Se GraphQL.org

• "…en öppen specifikation för ett flexibelt API-lager. Placera GraphQL över era befintliga bakgrunder för att skapa produkter snabbare än någonsin …".

  Se Utforska GraphQL.

• "…ett datameddelande och en specifikation som utvecklats internt av Facebook 2012 innan de blev offentligt tillgängliga 2015. Det är ett alternativ till REST-baserade arkitekturer i syfte att öka utvecklarnas produktivitet och minimera mängden data som överförs. GraphQL används i produktionen av hundratals organisationer av alla storlekar…"

  Se GraphQL Foundation.

Mer information om GraphQL API finns i följande avsnitt (bland annat på engelska):

• At graphql.org:

  • Introduktion till GraphQL

  • GraphQL-specifikationen

• At graphql.com:

  • Stödlinjer

  • Självstudiekurser

  • Fallstudier

Implementeringen av GraphQL för AEM baseras på GraphQL Java Library. Se:

• graphQL.org - Java

• GraphQL Java på GitHub

GraphQL Terminologi

GraphQL använder följande:

• Frågor

• Scheman och typer:

  • Scheman genereras av AEM baserat på modeller för innehållsfragment.
  • Med hjälp av dina scheman kan GraphQL presentera de typer och åtgärder som är tillåtna för implementeringen av GraphQL AEM.

• Fält

• GraphQL Endpoint

  • Sökvägen i AEM som svarar på GraphQL-frågor och ger åtkomst till GraphQL-scheman.

  • Se Aktivera din GraphQL-slutpunkt för mer information.

Se (GraphQL.org) Introduktion till GraphQL för utförlig information, inklusive Bästa praxis.

GraphQL Query Types

Med GraphQL kan du utföra frågor för att returnera:

• A enkel inmatning

• A lista över poster

AEM innehåller funktioner för att konvertera frågor (båda typerna) till Beständiga frågor som kan cachas av Dispatcher och CDN.

GraphQL Query Best Practices (Dispatcher and CDN)

The Beständiga frågor är den rekommenderade metod som ska användas för publiceringsinstanser som:

• de cachelagras
• de hanteras centralt av AEM as a Cloud Service

GraphQL-frågor som använder förfrågningar om POST rekommenderas inte eftersom de inte cachelagras, så i en standardinstans är Dispatcher konfigurerad att blockera sådana frågor.

Även om GraphQL har stöd för GET-förfrågningar kan dessa få träffgränser (till exempel längden på URL:en) som kan undvikas med beständiga frågor.

GraphiQL IDE

Du kan testa och felsöka GraphQL-frågor med GraphiQL IDE.

Användningsexempel för skribent- och publiceringsmiljöer

Användningsexemplen kan bero på vilken typ av AEM as a Cloud Service miljö det är:

• Publiceringsmiljö. används för att:

  • Frågedata för JS-program (standardfall)

• Författarmiljö; används för att:

  • Fråga efter data för"innehållshanteringssyften":
    • GraphQL i AEM as a Cloud Service är för närvarande ett skrivskyddat API.
    • REST API kan användas för CR(u)D-åtgärder.

Behörigheter

Behörigheterna är de som krävs för åtkomst av resurser.

GraphQL-frågor körs med tillstånd från den AEM användaren av den underliggande begäran. Om användaren inte har läsåtkomst till vissa fragment (som lagras som resurser) blir de inte en del av resultatuppsättningen.

Dessutom måste användaren ha åtkomst till en GraphQL-slutpunkt för att kunna köra GraphQL-frågor.

Schemagenerering

GraphQL är ett starkt typbestämt API, vilket innebär att data måste vara tydligt strukturerade och ordnade efter typ.

GraphQL-specifikationen innehåller en serie riktlinjer för hur du skapar ett robust API för att förhöra data i en viss instans. För att göra detta måste en kund hämta Schema, som innehåller alla typer som behövs för en fråga.

För innehållsfragment baseras GraphQL-scheman (struktur och typer) på Aktiverad Modeller för innehållsfragment och deras datatyper.

Om en användare till exempel har skapat en innehållsfragmentmodell som kallas ArticleAEM sedan generera en GraphQL-typ ArticleModel. Fälten i den här typen motsvarar fälten och datatyperna som definieras i modellen. Dessutom skapas vissa startpunkter för frågor som arbetar med den här typen, till exempel articleByPath eller articleList.

1. En innehållsfragmentmodell:

   

2. Motsvarande GraphQL-schema (utdata från den automatiska dokumentationen för GraphiQL):
   

   Detta visar att den genererade typen ArticleModel innehåller flera fält.

   • Tre av dem har kontrollerats av användaren: author, main och referencearticle.

   • De andra fälten lades till automatiskt av AEM och representerar användbara metoder för att tillhandahålla information om ett visst innehållsfragment. i det här exemplet hjälpfält) _path, _metadata, _variations.

3. När en användare har skapat ett innehållsfragment baserat på artikelmodellen kan det sedan förhöras via GraphQL. Mer information finns i Exempelfrågor (baserat på exempelstruktur för innehållsfragment för användning med GraphQL).

I GraphQL for AEM är schemat flexibelt. Det innebär att den genereras automatiskt varje gång en innehållsfragmentmodell skapas, uppdateras eller tas bort. Cacheminnen för dataschemat uppdateras också när du uppdaterar en innehållsfragmentmodell.

Cacheminnen för dataschemat uppdateras också när du uppdaterar en innehållsfragmentmodell.

Tjänsten Sites GraphQL avlyssnar (i bakgrunden) alla ändringar som görs i en innehållsfragmentmodell. När uppdateringar upptäcks återskapas endast den delen av schemat. Denna optimering sparar tid och ger stabilitet.

Om du till exempel:

1. Installera ett paket som innehåller Content-Fragment-Model-1 och Content-Fragment-Model-2:

   1. GraphQL-typer för Model-1 och Model-2 kommer att genereras.

2. Ändra sedan Content-Fragment-Model-2:

   1. Endast Model-2 GraphQL Type kommer att uppdateras.

   2. med beaktande av följande: Model-1 kommer att förbli desamma.

Schemat hanteras via samma slutpunkt som GraphQL-frågorna, där klienthanteraren hanterar det faktum att schemat anropas med tillägget GQLschema. Du kan till exempel utföra en enkel GET begäran på /content/cq:graphql/global/endpoint.GQLschema resulterar i utdata från schemat med innehållstypen: text/x-graphql-schema;charset=iso-8859-1.

Schemagenerering - opublicerade modeller

När innehållsfragment är kapslade kan det hända att en överordnad Content Fragment Model publiceras, men ingen refererad modell gör det.

När detta inträffar genererar AEM en ofullständig Schema för den överordnade innehållsfragmentmodellen. Det innebär att fragmentreferensen, som är beroende av den opublicerade modellen, tas bort från schemat.

Fält

Inom schemat finns det enskilda fält av två baskategorier:

• Fält som du genererar.

  Ett urval av Datatyper används för att skapa fält baserat på hur du konfigurerar innehållsfragmentmodellen. Fältnamnen hämtas från Egenskapsnamn fält för Datatyp -fliken.

  • Det finns också Återge som inställning som ska beaktas, eftersom användare kan konfigurera vissa datatyper. Ett textfält med en rad kan till exempel konfigureras att innehålla flera textrader genom att välja multifield i listrutan.

• GraphQL for AEM genererar också ett antal hjälpfält.

Datatyper

GraphQL för AEM har stöd för en lista med typer. Alla Content Fragment Model-datatyper som stöds och motsvarande GraphQL-typer visas:

Content Fragment Model - datatyp	GraphQL Type	Beskrivning
Enkelradig text	String, [String]	Används för enkla strängar som författarnamn, platsnamn osv.
Flerradstext	String, [String]	Används för att skriva ut text, t.ex. brödtexten i en artikel
Siffra	Float, [Float]	Används för att visa flyttal och reguljära tal
Boolean	Boolean	Används för att visa kryssrutor → enkla sant/falskt-satser
Datum och tid	Calendar	Används för att visa datum och tid i ett ISO 8601-format. Beroende på vilken typ som valts finns det tre aromer som kan användas i AEM GraphQL: onlyDate, onlyTime, dateTime
Uppräkning	String	Används för att visa ett alternativ från en lista med alternativ som definieras när modellen skapas
Taggar	[String]	Används för att visa en lista över strängar som representerar taggar som används i AEM
Innehållsreferens	String, [String]	Används för att visa sökvägen till en annan resurs i AEM
Fragmentreferens	En modelltyp Ett fält: Model - Modelltyp, refereras direkt Multifält, med en referenstyp: [Model] - Array av typen Model, som refereras direkt från en array Multifält, med flera refererade typer: [AllFragmentModels] - Array med alla modelltyper, refererad från array med unionstyp	Används för att referera till en eller flera innehållsfragment av vissa modelltyper, som definieras när modellen skapades

Hjälpfält

Förutom datatyperna för användargenererade fält genererar GraphQL för AEM även ett antal hjälpare fält för att hjälpa till att identifiera ett innehållsfragment eller för att ge ytterligare information om ett innehållsfragment.

Dessa hjälpfält markeras med föregående _ för att skilja mellan vad som har definierats av användaren och vad som har genererats automatiskt.

Bana

Sökvägsfältet används som en identifierare i AEM GraphQL. Den representerar sökvägen till Content Fragment-resursen i AEM. Vi har valt detta som identifierare för ett innehållsfragment eftersom det:

• är unikt inom AEM,
• kan enkelt hämtas.

I följande kod visas sökvägarna för alla innehållsfragment som har skapats baserat på modellen för innehållsfragment Author, enligt självstudiekursen för WKND.

{
  authorList {
    items {
      _path
    }
  }
}

Om du vill hämta ett enstaka innehållsfragment av en viss typ måste du också bestämma sökvägen först. Till exempel:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _path
      firstName
      lastName
    }
  }
}

Se Exempelfråga - Ett enskilt specifikt stadsfragment.

Metadata

Via GraphQL visar AEM också metadata för ett innehållsfragment. Metadata är den information som beskriver ett innehållsfragment, till exempel titeln på ett innehållsfragment, miniatyrsökvägen, beskrivningen av ett innehållsfragment och datumet då det skapades, bland annat.

Eftersom metadata genereras via Schemaredigeraren och därför inte har någon särskild struktur, har TypedMetaData GraphQL-typ implementerades för att visa metadata för ett innehållsfragment. TypedMetaData visar informationen som grupperats med följande skalära typer:

Fält
stringMetadata:[StringMetadata]!
stringArrayMetadata:[StringArrayMetadata]!
intMetadata:[IntMetadata]!
intArrayMetadata:[IntArrayMetadata]!
floatMetadata:[FloatMetadata]!
floatArrayMetadata:[FloatArrayMetadata]!
booleanMetadata:[BooleanMetadata]!
booleanArrayMetadata:[booleanArrayMetadata]!
calendarMetadata:[CalendarMetadata]!
calendarArrayMetadata:[CalendarArrayMetadata]!

Varje skalär typ representerar antingen ett namn/värde-par eller en array med namn/värde-par, där värdet för det paret är av den typ som det grupperades i.

Om du till exempel vill hämta titeln för ett innehållsfragment vet vi att den här egenskapen är en String-egenskap, så vi frågar efter alla strängmetadata:

Så här frågar du efter metadata:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _metadata {
        stringMetadata {
          name
          value
        }
      }
    }
  }
}

Du kan visa alla metadata för GraphQL-typer om du visar det genererade GraphQL-schemat. Alla modelltyper har samma TypedMetaData.

Se Exempelfråga för metadata - Ange metadata för utmärkelserna med namnet GB.

Variationer

The _variations -fältet har implementerats för att förenkla frågor om variationer som ett innehållsfragment har. Till exempel:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo") {
    item {
      _variations
    }
  }
}

Se Exempelfråga - Alla städer med en namngiven variant.

GraphQL Variables

GraphQL tillåter att variabler placeras i frågan. Mer information finns i GraphQL-dokumentation för variabler.

Om du till exempel vill hämta alla innehållsfragment av typen Author i en viss variant (om den är tillgänglig) kan du ange argumentet variation i GraphiQL.

Fråga:

query($variation: String!) {
  authorList(variation: $variation) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

Frågevariabler:

{
  "variation": "another"
}

Frågan returnerar den fullständiga listan med författare. Författare utan another återgår till originaldata (_variation kommer att rapportera master i detta fall).

Om du vill begränsa listan till författare som anger den angivna varianten (och hoppa över författare som skulle återgå till originaldata) måste du använda en filter:

query($variation: String!) {
  authorList(variation: $variation, filter: {
    _variation: {
      _expressions: {
        value: $variation
      }
    }
  }) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

GraphQL-direktiv

I GraphQL finns en möjlighet att ändra frågan baserat på variabler, så kallade GraphQL-direktiv.

Du kan till exempel inkludera adventurePrice fält i en fråga för alla AdventureModels, baserat på en variabel includePrice.

Fråga:

query GetAdventureByType($includePrice: Boolean!) {
  adventureList {
    items {
      title
      price @include(if: $includePrice)
    }
  }
}

Frågevariabler:

{
    "includePrice": true
}

Filtrering

Du kan också använda filtrering i dina GraphQL-frågor för att returnera specifika data.

Vid filtrering används en syntax som baseras på logiska operatorer och uttryck.

Den mest atomiska delen är ett enstaka uttryck som kan tillämpas på innehållet i ett visst fält. Innehållet i fältet jämförs med ett givet konstantvärde.

Uttrycket

{
  value: "some text"
  _op: EQUALS
}

skulle jämföra innehållet i fältet med värdet some text och lyckas om innehållet är lika med värdet. Annars misslyckas uttrycket.

Följande operatorer kan användas för att jämföra fält med ett visst värde:

Operator	Typ(er)	Uttrycket lyckas om …
EQUALS	String, ID, Boolean	… värdet är exakt detsamma som fältets innehåll
EQUALS_NOT	String, ID	… värdet är not samma som fältets innehåll
CONTAINS	String	… innehållet i fältet innehåller värdet ({ value: "mas", _op: CONTAINS } matchar Christmas, Xmas, master, …)
CONTAINS_NOT	String	… fältets innehåll not innehåller värdet
STARTS_WITH	ID	… ID:t börjar med ett visst värde ({ value: "/content/dam/", _op: STARTS_WITH matchar /content/dam/path/to/fragment, men inte /namespace/content/dam/something
EQUAL	Int, Float	… värdet är exakt detsamma som fältets innehåll
UNEQUAL	Int, Float	… värdet är not samma som fältets innehåll
GREATER	Int, Float	… innehållet i fältet är större än värdet
GREATER_EQUAL	Int, Float	… innehållet i fältet är större än eller lika med värdet
LOWER	Int, Float	… innehållet i fältet är lägre än värdet
LOWER_EQUAL	Int, Float	… innehållet i fältet är mindre än eller lika med värdet
AT	Calendar, Date, Time	… innehållet i fältet är exakt detsamma som värdet (inklusive tidszonsinställning)
NOT_AT	Calendar, Date, Time	… innehållet i fältet är not samma som värdet
BEFORE	Calendar, Date, Time	… den tidpunkt som anges av värdet är före den tidpunkt som anges av fältets innehåll
AT_OR_BEFORE	Calendar, Date, Time	… den tidpunkt som anges av värdet är före eller vid samma tidpunkt som anges av fältets innehåll
AFTER	Calendar, Date, Time	… den tidpunkt som anges av värdet är efter den tidpunkt som anges av fältets innehåll
AT_OR_AFTER	Calendar, Date, Time	… den tidpunkt som anges av värdet är efter eller vid samma tidpunkt som anges av fältets innehåll

I vissa typer kan du även ange ytterligare alternativ som ändrar hur ett uttryck utvärderas:

Alternativ	Typ(er)	Beskrivning
_ignoreCase	String	Ignorerar skiftläget för en sträng, t.ex. värdet time matchar TIME, time, tImE, …
_sensitiveness	Float	Tillåter en viss marginal för float värden som ska anses vara desamma (för att kringgå tekniska begränsningar på grund av den interna representationen av float Värden. bör undvikas eftersom detta alternativ kan ha en negativ inverkan på prestandan

Uttryck kan kombineras till en uppsättning med hjälp av en logisk operator (_logOp):

• OR - uttrycksuppsättningen lyckas om minst ett uttryck lyckas
• AND - uttrycksuppsättningen lyckas om alla uttryck lyckas (standard)

Varje fält kan filtreras med en egen uppsättning uttryck. Uttrycksuppsättningarna för alla fält som omnämns i filterargumentet kombineras till slut av den egna logiska operatorn.

En filterdefinition (skickas som filter argument till en fråga) innehåller:

• En underdefinition för varje fält (fältet kan nås via sitt namn, t.ex. finns det en lastName i filtret för lastName i fältet Data (fälttyp)
• Varje underdefinition innehåller _expressions -array som innehåller uttrycksuppsättningen och _logOp fält som definierar den logiska operatorn ska uttrycken kombineras med
• Varje uttryck definieras av värdet (value fält) och operatorn (_operator fält) innehållet i ett fält ska jämföras med

Observera att du kan utesluta _logOp om du vill kombinera objekt med AND och _operator om du vill kontrollera likhet, eftersom det här är standardvärdena.

I följande exempel visas en fullständig fråga som filtrerar alla personer som har en lastName av Provo eller innehåller sjö, oberoende av omständigheterna:

{
  authorList(filter: {
    lastname: {
      _logOp: OR
      _expressions: [
        {
          value: "sjö",
          _operator: CONTAINS,
          _ignoreCase: true
        },
        {
          value: "Provo"
        }
      ]
    }
  }) {
    items {
      lastName
      firstName
    }
  }
}

Du kan även filtrera efter kapslade fält, men det rekommenderas inte eftersom det kan leda till prestandaproblem.

Ytterligare exempel finns i:

• information om GraphQL för AEM tillägg

• Exempelfrågor med detta exempelinnehåll och -struktur

  • Och Exempelinnehåll och struktur förberedda för användning i provfrågor

• Exempelfrågor baserade på WKND-projektet

Sortering

Med den här funktionen kan du sortera frågeresultaten efter ett angivet fält.

Sorteringskriterierna:

• är en kommaavgränsad lista med värden som representerar fältsökvägen
  • det första fältet i listan definierar den primära sorteringsordningen, det andra fältet används om två värden för det primära sorteringsvillkoret är lika, det tredje om de första två kriterierna är lika, osv.
  • punktnotation, t.ex. field1.subfield.subfield osv.
• med valfri orderriktning
  • ASC (stigande) eller DESC (fallande). som standard används ASC
  • Riktningen kan anges per fält. det innebär att du kan sortera ett fält i stigande ordning och ett annat i fallande ordning (name, firstName DESC)

Till exempel:

query {
  authorList(sort: "lastName, firstName") {
    items {
      firstName
      lastName
    }
  }
}

Och dessutom:

{
  authorList(sort: "lastName DESC, firstName DESC") {
    items {
        lastName
        firstName
    }
  }
}

Du kan även sortera ett fält i ett kapslat fragment med formatet nestedFragmentname.fieldname.

Till exempel:

query {
  articleList(sort: "authorFragment.lastName")  {
    items {
      title
      authorFragment {
        firstName
        lastName
        birthDay
      }
      slug
    }
  }
}

Sidindelning

Med den här funktionen kan du utföra sidindelning på frågetyper som returnerar en lista. Det finns två metoder:

• offset och limit i en List fråga
• first och after i en Paginated fråga

Listfråga - förskjutning och begränsning

I en ...Listfråga som du kan använda offset och limit om du vill returnera en viss delmängd av resultaten:

• offset: Anger den första datauppsättningen som ska returneras
• limit: Anger det maximala antalet datauppsättningar som ska returneras

Om du till exempel vill visa en resultatsida som innehåller upp till fem artiklar, med början från den femte artikeln från complete resultatlista:

query {
   articleList(offset: 5, limit: 5) {
    items {
      authorFragment {
        lastName
        firstName
      }
    }
  }
}

Sidnumrerad fråga - första och efter

The ...Paginated frågetypen återanvänder de flesta ...List frågetypsfunktioner (filtrering, sortering), men i stället för att använda offset/limit argument, använder first/after argument som definieras av GraphQL Cursor Connections Specification. Du hittar en mindre formell introduktion i GraphQL introduktion.

• first: The n de första objekten som ska returneras.
  Standardvärdet är 50.
  Maxvärdet är 100.
• after: Den markör som bestämmer början på den begärda sidan. Observera att det objekt som markören representerar inte ingår i resultatuppsättningen. markören för ett objekt bestäms av cursor fält för edges struktur.

Du kan till exempel skriva ut en resultatsida som innehåller upp till fem äventyr, med början från det angivna markörobjektet i complete resultatlista:

query {
    adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
        edges {
          cursor
          node {
            title
          }
        }
        pageInfo {
          endCursor
          hasNextPage
        }
    }
}

Webboptimerad bildleverans i GraphQL-frågor

Med webboptimerad bildleverans kan du använda en Graphql-fråga för att:

• Begär en URL till en AEM

• Skicka parametrar med frågan så att en viss återgivning av bilden genereras och returneras automatiskt

  OBSERVERA

  Den angivna återgivningen lagras inte i AEM Assets. Återgivningen genereras och sparas i cache-minnet under en kort period.

• Returnera URL:en som en del av JSON-leveransen

Du kan använda AEM för att:

• Pass Webboptimerad bildleverans till GraphQL-frågor.

Det innebär att kommandona tillämpas under frågekörningen, på samma sätt som URL-parametrar vid GET-begäranden för dessa bilder.

På så sätt kan du dynamiskt skapa bildåtergivningar för JSON-leverans, vilket innebär att du slipper skapa och lagra dessa återgivningar manuellt i databasen.

Med GraphQL kan man

• use _dynamicUrl på ImageRef referens

• add _assetTransform till listrubriken där filtren har definierats

Omformningsbegärans struktur

AssetTransform (_assetTransform) används för att göra URL-omvandlingsbegäranden.

Strukturen och syntaxen är:

• format: en uppräkning med alla format som stöds av tillägget: GIF, PNG, PNG8, JPG, PJPG, BJPG, WEBP, WEBPLL eller WEBPLY
• seoName: en sträng som ska användas som filnamn i stället för nodnamnet
• crop: en understruktur för en bildruta, om bredd eller höjd utelämnas, används höjden eller bredden som samma värde
  • xOrigin: bildrutans x-ursprung och är obligatoriskt
  • yOrigin: ramens y-ursprung och är obligatoriskt
  • width: ramens bredd
  • height: ramens höjd
• size: en dimensionsunderstruktur, om bredd eller höjd utelämnas, används höjden eller bredden som samma värde
  • width: dimensionens bredd
  • height: dimensionens höjd
• rotation: en uppräkning av alla rotationer som stöds: R90, R180, R270
• flip: en uppräkning av HORIZONTAL, VERTICAL, HORIZONTAL_AND_VERTICAL
• quality: ett heltal mellan 1 och 100 som anger procentvärdet för bildkvaliteten
• width: ett heltal som definierar bredden på utdatabilden men ignoreras av Image Generator
• preferWebp: ett booleskt värde som anger om webben är att föredra (standardvärdet är false)

URL-omformningen är tillgänglig för alla frågetyper: efter sökväg, lista eller sidnumrering.

Webboptimerad bildleverans med fullständiga parametrar

Här följer ett exempel på en fråga med en fullständig uppsättning parametrar:

{
  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
        }
      }
    }
  }
}

Webboptimerad bildleverans med en enda frågevariabel

I följande exempel visas användningen av en enda frågevariabel:

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
        }
      }
    }
  }
}

Webboptimerad bildleverans med flera frågevariabler

I följande exempel visas hur flera frågevariabler används:

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
        }
      }
    }
  }
}

Webboptimerad begäran om bildleverans via URL

Om du sparar frågan som en beständig fråga (till exempel med namnet dynamic-url-x) kan du köra den beständiga frågan direkt.

Om du till exempel vill köra de tidigare exemplen direkt (sparade som beständiga frågor) använder du följande URL:er:

• En parameter; Beständig fråga med namnet dynamic-url-x

  • http://localhost:4502/graphql/execute.json/wknd-shared/dynamic-url-x;seoName=xxx

    Svaret ser ut så här:

    

• Flera parametrar; Beständig fråga med namnet dynamic

  • http://localhost:4502/graphql/execute.json/wknd-shared/dynamic;seoName=billiboy;format=GIF;

    FÖRSIKTIGHET

    Efterföljande ;är obligatoriskt för att utan problem avsluta parameterlistan.

Begränsningar för bildleverans

Följande begränsningar finns:

• Modifierare som används för alla bilder i frågan (globala parametrar)

• Cachelagra rubriker

  • Ingen cachelagring av författare
  • Cachelagring vid publicering - max 10 minuters ålder (kan inte ändras av klienten)

GraphQL for AEM - i korthet

Den grundläggande funktionen för frågor med GraphQL för AEM följer GraphQL standardspecifikation. För GraphQL-frågor med AEM finns det några tillägg:

• Om du behöver ett enda resultat:

  • använda modellnamnet, eg stad

• Om du förväntar dig en resultatlista:

  • add List till modellnamnet, till exempel cityList
  • Se Exempelfråga - All information om alla städer

  Då kan du:

  • Sortera resultaten

    • ASC : stigande
    • DESC : fallande

  • Returnera en resultatsida med antingen:

    • En listfråga med förskjutning och begränsning
    • En sidnumrerad fråga med första och efter

  • Se Exempelfråga - All information om alla städer

• Om du vill använda ett logiskt OR:

  • use _logOp: OR
  • Se Exempelfråga - Alla personer som har namnet "Jobs" eller "Smith"

• Logiskt AND finns också, men är (ofta) implicit

• Du kan fråga efter fältnamn som motsvarar fälten i innehållsfragmentmodellen

  • Se Exempelfråga - Fullständig information om företagets VD och anställda

• Förutom fälten från modellen finns det vissa systemgenererade fält (föregås av understreck):

  • För innehåll:

    • _locale : för att avslöja språket, baserat på Language Manager

      • Se Exempelfråga för flera innehållsfragment för en viss språkinställning

    • _metadata : för att visa metadata för ditt fragment

      • Se Exempelfråga för metadata - Ange metadata för utmärkelserna med namnet GB

    • _model : tillåt frågor för en innehållsfragmentmodell (sökväg och rubrik)

      • Se Exempelfråga för en innehållsfragmentmodell från en modell

    • _path : sökvägen till ditt innehållsfragment i databasen

      • Se Exempelfråga - Ett enskilt specifikt stadsfragment

    • _reference : avslöja referenser, inkludera textbundna referenser i RTF-redigeraren

      • Se Exempelfråga för flera innehållsfragment med förhämtade referenser

    • _variation : för att visa specifika variationer i ditt innehållsfragment

      OBSERVERA

      Om den angivna varianten inte finns för ett innehållsfragment returneras den överordnad varianten som ett (fallback) standardvärde.

      • Se Exempelfråga - Alla städer med en namngiven variant

  • För bildleverans:

    • _dynamicUrl: på ImageRef referens

    • _assetTransform: i listrubriken där filtren har definierats

    • Se:

      • Exempelfråga för bildleverans med fullständiga parametrar

      • Exempelfråga för bildleverans med en enda angiven parameter

  • Och åtgärder:

    • _operator : tillämpa särskilda operatörer, EQUALS, EQUALS_NOT, GREATER_EQUAL, LOWER, CONTAINS, STARTS_WITH
      • Se Exempelfråga - Alla personer som inte har namnet "Jobs"
      • Se Exempelfråga - Alla annonser där _path börjar med ett visst prefix
    • _apply : tillämpa särskilda villkor, till exempel AT_LEAST_ONCE
      • Se Exempelfråga - Filtrera en array med ett objekt som måste förekomma minst en gång
    • _ignoreCase : för att ignorera skiftläget vid fråga
      • Se Exempelfråga - Alla städer med SAN i namnet, oavsett fall

• GraphQL-unionstyper stöds:

  • use ... on
    • Se Exempelfråga för ett innehållsfragment för en viss modell med en innehållsreferens

• Reservation vid fråga om kapslade fragment:

  • Om en viss variant inte finns i ett kapslat fragment, kommer Överordnad variationen skulle returneras.

Fråga GraphQL-slutpunkten från en extern webbplats

Om du vill komma åt GraphQL-slutpunkten från en extern webbplats måste du konfigurera:

• CORS-filter
• Referensfilter

Autentisering

Se Autentisering för fjärrfrågor AEM GraphQL-frågor om innehållsfragment.

Vanliga frågor

Frågor som har uppstått:

1. Q: "Hur skiljer sig GraphQL API för AEM från Query Builder API?"

   • A: "AEM GraphQL API ger total kontroll över JSON-utdata och är en branschstandard för att fråga efter innehåll.
     AEM planerar att investera i det AEM GraphQL API:t."

Självstudiekurs - Komma igång med AEM Headless och GraphQL

Söker du en praktisk självstudiekurs? Checka ut Komma igång med AEM Headless och GraphQL en komplett självstudiekurs som visar hur man bygger upp och exponerar innehåll med AEM GraphQL API:er och som används av en extern app, i ett headless CMS-scenario.