GraphQL API AEM voor gebruik met inhoudsfragmenten graphql-api-for-use-with-content-fragments

Leer hoe u inhoudsfragmenten in Adobe Experience Manager (AEM) kunt gebruiken met de AEM GraphQL API voor het leveren van inhoud zonder kop.

AEM GraphQL API die wordt gebruikt met Content Fragments is sterk gebaseerd op de standaard, open-source GraphQL API.

Door de GraphQL API in AEM te gebruiken, kunt u inhoudsfragmenten efficiënt aan JavaScript-clients leveren in CMS-implementaties zonder kop:

Vereisten prerequisites

Klanten die GraphQL gebruiken, moeten het AEM Content Fragment installeren met GraphQL Index Package 1.0.5. Zie de Opmerkingen bij de release voor nadere bijzonderheden.

De GraphQL API graphql-api

GraphQL is:

Raadpleeg de volgende secties (onder andere over veel andere bronnen) voor meer informatie over de GraphQL API:

De GraphQL for AEM-implementatie is gebaseerd op de standaard GraphQL Java™-bibliotheek. Zie:

GraphQL Terminologie graphql-terminology

GraphQL gebruikt het volgende:

Zie de (GraphQL.org) Inleiding tot GraphQL voor uitvoerige informatie, waaronder de Aanbevolen procedures.

GraphQL-querytypen graphql-query-types

Met GraphQL kunt u query's uitvoeren die worden geretourneerd:

AEM biedt mogelijkheden om query's (beide typen) om te zetten in Blijvende query's die door Dispatcher en CDN in het cachegeheugen worden opgeslagen.

Best practices voor GraphQL-query (Dispatcher en CDN) graphql-query-best-practices

Blijvende query's zijn de aanbevolen methode voor het publiceren van exemplaren als:

GraphQL-query's die gebruikmaken van POST-aanvragen worden niet aanbevolen omdat ze niet in de cache zijn opgeslagen, zodat in een standaardinstantie de Dispatcher is geconfigureerd om dergelijke query's te blokkeren.

Hoewel GraphQL ook GET-aanvragen ondersteunt, kunnen deze aanvragen limieten bereiken (bijvoorbeeld de lengte van de URL) die kunnen worden vermeden door middel van doorlopende query's.

Zie Het in cache plaatsen van doorlopende query's inschakelen voor nadere bijzonderheden.

GraphiQL Interface graphiql-interface

Tenuitvoerlegging van de norm GraphiQL kan worden gebruikt met AEM GraphQL.

Met deze interface kunt u query's rechtstreeks invoeren en testen.

Bijvoorbeeld:

De klasse biedt functies zoals syntaxismarkering, automatisch aanvullen en automatisch voorstellen, samen met een geschiedenis en online documentatie:

Kwesties gebruiken voor auteur- en publicatie-omgevingen use-cases-author-publish-environments

De gebruiksgevallen kunnen afhankelijk zijn van het type AEM omgeving:

Machtigingen permission

De machtigingen zijn vereist voor toegang tot middelen.

GraphQL query's worden uitgevoerd met toestemming van de AEM gebruiker van het onderliggende verzoek. Als de gebruiker geen leestoegang heeft tot bepaalde fragmenten (opgeslagen als elementen), maken deze geen deel uit van de resultatenset.

Ook, moet de gebruiker toegang tot een eindpunt van GraphQL hebben om de vragen van GraphQL in werking te kunnen stellen.

Schema genereren schema-generation

GraphQL is een getypeerde API, wat betekent dat de gegevens duidelijk gestructureerd en ingedeeld moeten zijn op basis van het type.

De GraphQL-specificatie biedt een aantal richtlijnen voor het maken van een robuuste API voor het ondervragen van gegevens over een bepaalde instantie. Om deze richtlijnen te voltooien, moet een cliënt halen Schema, die alle typen bevat die nodig zijn voor een query.

Voor inhoudsfragmenten zijn de GraphQL-schema's (structuur en typen) gebaseerd op Ingeschakeld Modellen van inhoudsfragmenten en hun gegevenstypen.

Als een gebruiker bijvoorbeeld een Content Fragment Model heeft gemaakt, genaamd ArticleAEM vervolgens een GraphQL-type genereert ArticleModel. De velden in dit type komen overeen met de velden en gegevenstypen die in het model zijn gedefinieerd. Bovendien leidt het tot sommige ingangspunten voor de vragen die op dit type werken, zoals articleByPath of articleList.

In GraphQL for AEM is het schema flexibel. Deze flexibiliteit betekent dat deze automatisch wordt gegenereerd wanneer een inhoudsfragmentmodel wordt gemaakt, bijgewerkt of verwijderd. De caches voor het gegevensschema worden ook vernieuwd wanneer u een model van het inhoudsfragment bijwerkt.

De service Sites GraphQL luistert (op de achtergrond) naar eventuele wijzigingen die zijn aangebracht in een inhoudsfragmentmodel. Wanneer updates worden ontdekt, slechts wordt dat deel van het schema opnieuw geproduceerd. Deze optimalisatie bespaart tijd en zorgt voor stabiliteit.

Als u bijvoorbeeld:

Het schema wordt gediend door het zelfde eindpunt zoals de vragen van GraphQL, met de cliënt die het feit behandelt dat het schema met de uitbreiding wordt geroepen GQLschema. U kunt bijvoorbeeld een eenvoudige GET verzoek op /content/cq:graphql/global/endpoint.GQLschema resulteert in de uitvoer van het schema met het inhoudstype: text/x-graphql-schema;charset=iso-8859-1.

Schema genereren - Niet-gepubliceerde modellen schema-generation-unpublished-models

Wanneer Inhoudsfragmenten zijn genest, kan een bovenliggend inhoudsfragmentmodel worden gepubliceerd, maar een model waarnaar wordt verwezen, niet.

Wanneer dit gebeurt, genereert AEM een onvolledig Schema voor het bovenliggende inhoudsfragmentmodel. Dit betekent dat de fragmentverwijzing, die afhankelijk is van het niet-gepubliceerde model, uit het schema wordt verwijderd.

Velden fields

Binnen het schema zijn er afzonderlijke velden, van twee basiscategorieën:

Gegevenstypen data-types

GraphQL for AEM ondersteunt een lijst met typen. Alle ondersteunde gegevenstypen van het inhoudsfragmentmodel en de bijbehorende GraphQL-typen worden weergegeven:

Helpervelden helper-fields

Naast de gegevenstypen voor door de gebruiker gegenereerde velden, genereert GraphQL for AEM ook verschillende helper velden voor het herkennen van een inhoudsfragment of voor aanvullende informatie over een inhoudsfragment.

Deze helpervelden zijn gemarkeerd met een voorgaande _ om onderscheid te maken tussen wat door de gebruiker is gedefinieerd en wat automatisch is gegenereerd.

Pad path

Het padveld wordt gebruikt als een identifier in AEM GraphQL. Het vertegenwoordigt het pad van het Content Fragment-element in de AEM opslagplaats. Dit pad wordt gekozen als de id van een inhoudsfragment, omdat het:

Met de volgende code worden de paden weergegeven van alle inhoudsfragmenten die zijn gemaakt op basis van het model van het inhoudsfragment Person.

{
  personList {
    items {
      _path
    }
  }
}

Als u één inhoudsfragment van een bepaald type wilt ophalen, moet u ook eerst het pad ervan bepalen. Bijvoorbeeld:

{
  authorByPath(_path: "/content/dam/path/to/fragment/john-doe") {
    item {
      _path
      firstName
      name
    }
  }
}

Zie Voorbeeldquery - één specifiek stedenfragment.

Metagegevens metadata

Via GraphQL worden AEM ook de metagegevens van een inhoudsfragment beschikbaar gemaakt. Metagegevens zijn de informatie die een inhoudsfragment beschrijft, zoals het volgende:

Omdat metagegevens worden gegenereerd via de Schema-editor en als zodanig geen specifieke structuur hebben, TypedMetaData Het GraphQL-type is geïmplementeerd om de metagegevens van een inhoudsfragment beschikbaar te maken. De TypedMetaData stelt de informatie bloot die door de volgende scalaire types wordt gegroepeerd:

Elk scalair type vertegenwoordigt of één enkel naam-waarde paar of een serie van naam-waarde paren, waar de waarde van dat paar van het type is het werd gegroepeerd.

Als u bijvoorbeeld de titel van een inhoudsfragment wilt ophalen, is deze eigenschap een eigenschap String, zodat u een query voor alle metagegevens van tekenreeks kunt uitvoeren:

Ga als volgt te werk om te zoeken naar metagegevens:

{
  personByPath(_path: "/content/dam/path/to/fragment/john-doe") {
    item {
      _path
      _metadata {
        stringMetadata {
          name
          value
        }
      }
    }
  }
}

U kunt alle GraphQL-typen voor metagegevens weergeven als u het schema Gegenereerde GraphQL weergeeft. Alle modeltypen hebben dezelfde TypedMetaData.

Zie Voorbeeldquery voor metagegevens - Lijst met metagegevens voor onderscheidingen: GB.

Variaties variations

De _variations is geïmplementeerd om het opvragen van variaties in een inhoudsfragment te vereenvoudigen. Bijvoorbeeld:

{
  personByPath(_path: "/content/dam/path/to/fragment/john-doe") {
    item {
      _variations
    }
  }
}

Zie Voorbeeldquery - Alle steden met een benoemde variatie.

GraphQL-variabelen graphql-variables

GraphQL staat toe dat variabelen in de query worden geplaatst. Zie voor meer informatie GraphQL-documentatie voor variabelen.

Als u bijvoorbeeld alle inhoudsfragmenten van het type wilt ophalen Article die een specifieke variatie hebben, kunt u de variabele opgeven variation in GraphiQL.

### query
query GetArticlesByVariation($variation: String!) {
    articleList(variation: $variation) {
        items {
            _path
            author
            _variations
        }
    }
}

### in query variables
{
    "variation": "uk"
}

GraphQL-richtlijnen graphql-directives

In GraphQL is er een mogelijkheid om de query te wijzigen op basis van variabelen, de zogenaamde GraphQL-richtlijnen.

Hier kunt u bijvoorbeeld de opdracht adventurePrice veld in een query voor alle AdventureModels, gebaseerd op een variabele includePrice.

### query
query GetAdventureByType($includePrice: Boolean!) {
  adventureList {
    items {
      adventureTitle
      adventurePrice @include(if: $includePrice)
    }
  }
}

### in query variables
{
    "includePrice": true
}

Filteren filtering

U kunt filteren ook gebruiken in uw GraphQL-query's om specifieke gegevens te retourneren.

Bij het filteren wordt een syntaxis gebruikt die is gebaseerd op logische operatoren en expressies.

Het meest atomische deel bestaat uit één expressie die kan worden toegepast op de inhoud van een bepaald veld. De inhoud van het veld wordt vergeleken met een bepaalde constante waarde.

De volgende expressie zou bijvoorbeeld de inhoud van het veld vergelijken met de waarde some texten slagen als de inhoud gelijk is aan de waarde. Anders mislukt de expressie:

{
  value: "some text"
  _op: EQUALS
}

De volgende operatoren kunnen worden gebruikt om velden met een bepaalde waarde te vergelijken:

Bij sommige typen kunt u ook aanvullende opties opgeven die wijzigen hoe een expressie wordt geëvalueerd:

Expressies kunnen met behulp van een logische operator worden gecombineerd tot een set (_logOp):

Elk veld kan met een eigen set expressies worden gefilterd. De expressiesets van alle velden die in het filterargument worden vermeld, worden uiteindelijk gecombineerd door de eigen logische operator.

Een filterdefinitie (doorgegeven als de filter argument voor een query) bevat:

U kunt weglaten _logOp als je objecten wilt combineren met AND en _operator als u op gelijkheid wilt controleren, omdat deze waarden standaardwaarden zijn.

Het volgende voorbeeld toont een volledige vraag aan die alle personen filtert die een lastName van Provo of die sjöonafhankelijk van de zaak:

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

Wanneer u een GraphQL-query uitvoert met behulp van optionele variabelen, als een specifieke waarde niet gegeven voor de facultatieve variabele, dan zal de variabele in de filterevaluatie worden genegeerd. Dit betekent dat zoekresultaten alle waarden bevatten, beide null en niet null, voor de eigenschap met betrekking tot de filtervariabele.

In de query hieronder ziet u bijvoorbeeld waar geen waarde is opgegeven voor de eigenschap lastName:

query getAuthorsFilteredByLastName($authorLastName: String) {
  authorList(filter:
    {
      lastName: {_expressions: {value: $authorLastName}
      }}) {
    items {
      lastName
    }
  }
}

Alle auteurs worden geretourneerd:

{
  "data": {
    "authorList": {
      "items": [
        {
          "lastName": "Hammer"
        },
        {
          "lastName": "Provo"
        },
        {
          "lastName": "Wester"
        },
        {
          "lastName": null
        },
         ...
      ]
    }
  }
}

U kunt ook filteren op geneste velden, maar dit wordt afgeraden omdat dit tot prestatieproblemen kan leiden.

Zie voor meer voorbeelden:

Sorteren sorting

Met deze functie kunt u de zoekresultaten sorteren op basis van een opgegeven veld.

De sorteercriteria:

Bijvoorbeeld:

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

En ook:

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

U kunt ook sorteren op een veld in een genest fragment in de notatie nestedFragmentname.fieldname.

Bijvoorbeeld:

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

Paginering paging

Met deze functie kunt u pagineren uitvoeren op querytypen die een lijst retourneren. Er zijn twee methoden:

Lijstquery - Verschuiven en beperken list-offset-limit

In een ...Listquery die u kunt gebruiken offset en limit om een specifieke subset van resultaten te retourneren:

Als u bijvoorbeeld de resultatenpagina wilt weergeven met maximaal vijf artikelen, te beginnen bij het vijfde artikel van het dialoogvenster complete resultatenlijst:

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

Gepagineerde query - eerste en volgende paginated-first-after

De ...Paginated het vraagtype gebruikt het grootste deel van ...List functies voor querytypen (filteren, sorteren), maar in plaats van offset/limit argumenten, gebruikt het de first/after argumenten zoals gedefinieerd door de GraphQL Cursor Connections Specification. U vindt een minder formele introductie in het dialoogvenster Inleiding GraphQL.

Voer bijvoorbeeld de resultatenpagina uit met maximaal vijf avonturen, te beginnen bij het opgegeven cursoritem in het dialoogvenster complete resultatenlijst:

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

GraphQL Persisted Queries - caching inschakelen in Dispatcher graphql-persisted-queries-enabling-caching-dispatcher

Caching van persisted query's wordt niet standaard ingeschakeld in de Dispatcher. De standaard enablement is niet mogelijk aangezien de klanten die CORS (het Delen van het Middel van de Cross-Origin) met veelvoudige oorsprong gebruiken hun configuratie van de Verzender moeten herzien en misschien bijwerken.

Het in cache plaatsen van doorlopende query's inschakelen enable-caching-persisted-queries

Om het in cache plaatsen van persisted query's in te schakelen, zijn de volgende updates van de Dispatcher-configuratiebestanden vereist:

CORS-configuratie in de Dispatcher cors-configuration-in-dispatcher

Klanten die CORS-verzoeken gebruiken, moeten mogelijk hun CORS-configuratie in de Dispatcher controleren en bijwerken.

GraphQL for AEM - Overzicht van extensies graphql-extensions

De basisverrichting van vragen met GraphQL voor AEM voldoet aan de standaardspecificatie van GraphQL. Voor GraphQL-query's met AEM zijn er een aantal extensies:

CORS-filter cors-filter

Om tot het eindpunt van GraphQL toegang te hebben, vorm een beleid CORS in de bewaarplaats van de Kit van de klant. Deze configuratie wordt gedaan door een aangewezen OSGi CORS configuratiedossier voor één of meerdere gewenste eindpunten toe te voegen.

Deze configuratie moet een vertrouwde website-oorsprong opgeven alloworigin of alloworiginregexp waarvoor toegang moet worden verleend.

Bijvoorbeeld, om toegang tot het eindpunt van GraphQL en voortgeduurde vragen te verlenen eindpunt voor https://my.domain u kunt gebruiken:

{
  "supportscredentials":true,
  "supportedmethods":[
    "GET",
    "HEAD",
    "POST"
  ],
  "exposedheaders":[
    ""
  ],
  "alloworigin":[
    "https://my.domain"
  ],
  "maxage:Integer":1800,
  "alloworiginregexp":[
    ""
  ],
  "supportedheaders":[
    "Origin",
    "Accept",
    "X-Requested-With",
    "Content-Type",
    "Access-Control-Request-Method",
    "Access-Control-Request-Headers"
  ],
  "allowedpaths":[
    "/content/_cq_graphql/global/endpoint.json",
    "/graphql/execute.json/.*"
  ]
}

Als u een ijdelingspad voor het eindpunt hebt gevormd, kunt u het binnen ook gebruiken allowedpaths.

Refererfilter referrer-filter

Naast de configuratie CORS, moet een filter van de Referateur worden gevormd om toegang van derdegastheren toe te staan.

Dit filter wordt gedaan door een aangewezen OSGi de configuratiedossier van de Filter toe te voegen dat:

Bijvoorbeeld om toegang voor verzoeken met de Referiteur te verlenen my.domain u kunt:

{
    "allow.empty":false,
    "allow.hosts":[
      "my.domain"
    ],
    "allow.hosts.regexp":[
      ""
    ],
    "filter.methods":[
      "POST",
      "PUT",
      "DELETE",
      "COPY",
      "MOVE"
    ],
    "exclude.agents.regexp":[
      ""
    ]
}

Beperkingen limitations

Om tegen potentiële problemen te beschermen worden er standaardbeperkingen opgelegd aan uw vragen:

U moet zich ook bewust zijn van:

Verificatie authentication

Zie Verificatie voor externe AEM GraphQL-query's op inhoudsfragmenten.

Veelgestelde vragen faqs

De gerezen vragen:

Zelfstudie - Aan de slag met AEM Headless en GraphQL tutorial

Op zoek naar een praktische zelfstudie? Uitchecken Aan de slag met AEM Headless en GraphQL end-to-end zelfstudie waarin wordt geïllustreerd hoe u in een CMS-scenario inhoud kunt ontwikkelen en beschikbaar maken met behulp van AEM GraphQL API's en die door een externe toepassing wordt verbruikt.