AEM API GraphQL per l’utilizzo con frammenti di contenuto

Scopri come utilizzare Frammenti di contenuto in Adobe Experience Manager (AEM) con l’API GraphQL AEM per la distribuzione di contenuti headless.

L’API GraphQL utilizzata con i frammenti di contenuto si basa principalmente sull’API GraphQL standard open source.

L’utilizzo dell’API GraphQL in AEM consente la distribuzione efficiente di frammenti di contenuto ai client JavaScript in implementazioni CMS headless:

  • Evitare richieste API iterative come con REST,
  • garantire che la consegna sia limitata ai requisiti specifici,
  • Consentire la distribuzione in massa di esattamente ciò che è necessario per il rendering come risposta a una singola query API.
NOTA

GraphQL è attualmente utilizzato in due scenari (separati) in Adobe Experience Manager (AEM):

API GraphQL

GraphQL è:

  • "…un linguaggio di query per le API e un runtime per l’esecuzione di tali query con i dati esistenti. GraphQL fornisce una descrizione completa e comprensibile dei dati nell’API, offre ai clienti la possibilità di chiedere esattamente ciò di cui hanno bisogno e niente di più, semplifica l’evoluzione delle API nel tempo e consente potenti strumenti per gli sviluppatori.".

    Vedi GraphQL.org

  • "…una specifica aperta per un livello API flessibile. Posiziona GraphQL sui backend esistenti per creare prodotti più rapidamente che mai…".

    Vedi Esplorare GraphQL.

  • "…un linguaggio e una specifica di query di dati sviluppati internamente da Facebook nel 2012 prima di essere pubblicamente aperti dal 2015. Offre un’alternativa alle architetture basate su REST allo scopo di aumentare la produttività degli sviluppatori e ridurre al minimo le quantità di dati trasferiti. GraphQL viene utilizzato nella produzione da centinaia di organizzazioni di tutte le dimensioni…"

    Vedi GraphQL Foundation.

Per ulteriori informazioni sull’API GraphQL, consulta le sezioni seguenti (tra cui molte altre risorse):

GraphQL per AEM implementazione si basa sulla libreria Java GraphQL standard. Consulta:

Terminologia GraphQL

GraphQL utilizza quanto segue:

  • Query

  • Schemi e tipi:

    • Gli schemi vengono generati da AEM in base ai modelli di frammenti di contenuto.
    • Utilizzando i tuoi schemi, GraphQL presenta i tipi e le operazioni consentiti per l’implementazione AEM GraphQL.
  • Campi

  • Endpoint GraphQL

Consulta la sezione (GraphQL.org) Introduzione a GraphQL per informazioni complete, tra cui Best practice.

Tipi di query GraphQL

Con GraphQL è possibile eseguire query per restituire:

Puoi anche eseguire le seguenti operazioni:

NOTA

Puoi testare ed eseguire il debug delle query GraphQL utilizzando IDE GraphiQL.

GraphQL per AEM endpoint

L’endpoint è il percorso utilizzato per accedere a GraphQL per AEM. Utilizzando questo percorso (o la tua app) puoi:

  • accedere allo schema GraphQL,
  • invia le query GraphQL,
  • ricevere le risposte (alle query GraphQL).

Esistono due tipi di endpoint in AEM:

  • Globale
    • Disponibile per tutti i siti.
    • Questo endpoint può utilizzare tutti i modelli di frammenti di contenuto di tutte le configurazioni di Sites (definite nella sezione Browser di configurazione).
    • Se esistono modelli di frammento di contenuto che devono essere condivisi tra le configurazioni di Sites, questi devono essere creati nelle configurazioni di Sites globali.
  • Configurazioni siti:
    • Corrisponde a una configurazione Sites, come definita nella Browser di configurazione.
    • Specifico per un sito/progetto specifico.
    • Un endpoint specifico per la configurazione di Sites utilizzerà i modelli di frammento di contenuto di quella specifica configurazione di Sites insieme a quelli della configurazione di Sites globale.
ATTENZIONE

L’Editor frammento di contenuto può consentire a un frammento di contenuto di una configurazione Sites di fare riferimento a un frammento di contenuto di un’altra configurazione Sites (tramite criteri).

In questo caso non tutti i contenuti saranno recuperabili utilizzando un endpoint specifico per la configurazione di Sites.

L’autore del contenuto deve controllare questo scenario; ad esempio, potrebbe essere utile considerare l’idea di inserire modelli di frammenti di contenuto condivisi nella configurazione Siti globali .

Il percorso dell'archivio di GraphQL per AEM endpoint globale è:

/content/cq:graphql/global/endpoint

Per cui l’app può utilizzare il seguente percorso nell’URL della richiesta:

/content/_cq_graphql/global/endpoint.json

Per abilitare un endpoint per GraphQL per AEM è necessario:

Abilitazione dell’endpoint GraphQL

Per abilitare un endpoint GraphQL è innanzitutto necessario disporre di una configurazione appropriata. Vedi Frammenti di contenuto - Browser di configurazione.

ATTENZIONE

Se la l’utilizzo di modelli di frammento di contenuto non è stato abilitato, Crea l’opzione non sarà disponibile.

Per abilitare l'endpoint corrispondente:

  1. Passa a Strumenti, Risorse, quindi seleziona GraphQL.

  2. Seleziona Crea.

  3. La Crea nuovo endpoint GraphQL si aprirà la finestra di dialogo . Qui puoi specificare:

    • Nome: nome del punto finale; puoi immettere qualsiasi testo.
    • Utilizza lo schema GraphQL fornito da: utilizza il menu a discesa per selezionare il sito o il progetto richiesto.
    NOTA

    Nella finestra di dialogo viene visualizzato il seguente avviso:

    • Se non vengono gestiti correttamente, gli endpoint GraphQL possono introdurre problemi di prestazioni e sicurezza dei dati. Dopo aver creato un endpoint, assicurati di impostare le autorizzazioni appropriate.
  4. Conferma con Crea.

  5. La Passaggi successivi La finestra di dialogo fornisce un collegamento diretto alla console Sicurezza per garantire che l’endpoint appena creato disponga delle autorizzazioni appropriate.

    ATTENZIONE

    L’endpoint è accessibile a tutti. Questo può creare problemi di sicurezza, soprattutto per le istanze di pubblicazione, in quanto le query GraphQL possono imporre un carico pesante sul server.

    Puoi impostare ACL, appropriati al tuo caso d'uso, sull'endpoint.

Pubblicazione dell’endpoint GraphQL

Seleziona il nuovo endpoint e Pubblica per renderlo completamente disponibile in tutti gli ambienti.

ATTENZIONE

L’endpoint è accessibile a tutti.

Nelle istanze di pubblicazione questo può rappresentare un problema di sicurezza, in quanto le query GraphQL possono imporre un carico pesante sul server.

Devi impostare ACL appropriati al tuo caso d'uso sull'endpoint.

Interfaccia GraphiQL

Attuazione dello standard GraphiQL È disponibile per l’utilizzo con AEM GraphQL. Questo può essere installato con AEM.

NOTA

GraphiQL è associato all’endpoint globale (e non funziona con altri endpoint per configurazioni specifiche di Sites).

Questa interfaccia ti consente di inserire e testare direttamente le query.

Esempio:

  • http://localhost:4502/content/graphiql.html

Questo fornisce funzioni quali evidenziazione della sintassi, completamento automatico, auto-suggerimento, insieme a una cronologia e a una documentazione online:

Interfaccia GraphiQL

Installazione dell'interfaccia AEM GraphiQL

L'interfaccia utente GraphiQL può essere installata su AEM con un pacchetto dedicato: la Pacchetto di contenuti GraphiQL v0.0.6 (2021.3) pacchetto.

NOTA

Il pacchetto disponibile è completamente compatibile con AEM 6.5.10.0 e AEM as a Cloud Service.

Casi d’uso per ambienti di authoring e pubblicazione

I casi di utilizzo possono dipendere dal tipo di ambiente AEM:

  • ambiente di pubblicazione; utilizzato per:

    • Dati query per l’applicazione JS (caso d’uso standard)
  • Ambiente di authoring; utilizzato per:

    • Dati query per "scopo di gestione del contenuto":
      • GraphQL in AEM è attualmente un'API di sola lettura.
      • L’API REST può essere utilizzata per le operazioni CR(u)D.

Autorizzazioni

Le autorizzazioni sono quelle necessarie per accedere ad Assets.

Generazione schema

GraphQL è un’API fortemente tipizzata, il che significa che i dati devono essere chiaramente strutturati e organizzati per tipo.

La specifica GraphQL fornisce una serie di linee guida su come creare una solida API per l'interrogazione dei dati su una determinata istanza. A questo scopo, un client deve recuperare il Schema, che contiene tutti i tipi necessari per una query.

Per i frammenti di contenuto, gli schemi GraphQL (struttura e tipi) sono basati su Abilitato Modelli per frammenti di contenuto e i relativi tipi di dati.

ATTENZIONE

Tutti gli schemi GraphQL (derivati dai modelli di frammenti di contenuto che sono stati Abilitato) sono leggibili attraverso l’endpoint GraphQL .

Ciò significa che devi assicurarti che non siano disponibili dati sensibili, in quanto potrebbero essere trapelati in questo modo; ad esempio, include informazioni che potrebbero essere presenti come nomi di campo nella definizione del modello.

Ad esempio, se un utente ha creato un modello di frammento di contenuto denominato Article, quindi AEM genera l’oggetto article di un tipo ArticleModel. I campi all’interno di questo tipo corrispondono ai campi e ai tipi di dati definiti nel modello.

  1. Un Modello Di Frammento Di Contenuto:

    Modello per frammenti di contenuto da utilizzare con GraphQL

  2. Lo schema GraphQL corrispondente (output dalla documentazione automatica GraphiQL):
    Schema GraphQL basato su modello di frammento di contenuto

    Mostra il tipo generato ArticleModel contiene diversi field.

    • Tre di essi sono stati controllati dall’utente: author, main e referencearticle.

    • Gli altri campi sono stati aggiunti automaticamente da AEM e rappresentano metodi utili per fornire informazioni su un determinato frammento di contenuto; in questo esempio, _path, _metadata, _variations. Tali campi di supporto sono contrassegnate con un _ per distinguere tra ciò che è stato definito dall’utente e ciò che è stato generato automaticamente.

  3. Dopo che un utente crea un frammento di contenuto basato sul modello di articolo, può essere interrogato tramite GraphQL. Per esempi, consulta la sezione Query di esempio (basato su un struttura dei frammenti di contenuto di esempio da utilizzare con GraphQL).

In GraphQL per AEM, lo schema è flessibile. Ciò significa che viene generato automaticamente ogni volta che viene creato, aggiornato o eliminato un modello di frammento di contenuto. Le cache dello schema dati vengono aggiornate anche quando si aggiorna un modello di frammento di contenuto.

Il servizio GraphQL di Sites ascolta (in background) le modifiche apportate a un modello di frammento di contenuto. Quando vengono rilevati aggiornamenti, viene rigenerata solo la parte dello schema. Questa ottimizzazione consente di risparmiare tempo e di garantire stabilità.

Ad esempio, se:

  1. Installa un pacchetto contenente Content-Fragment-Model-1 e Content-Fragment-Model-2:

    1. Tipi GraphQL per Model-1 e Model-2 verrà generato.
  2. Quindi modificare Content-Fragment-Model-2:

    1. Solo il Model-2 Il tipo GraphQL verrà aggiornato.

    2. considerando che Model-1 rimarrà lo stesso.

NOTA

Questo è importante da notare nel caso in cui desideri eseguire aggiornamenti in blocco sui modelli di frammenti di contenuto tramite l’api REST o in altro modo.

Lo schema viene gestito attraverso lo stesso endpoint delle query GraphQL, con il client che gestisce il fatto che lo schema viene chiamato con l'estensione GQLschema. Ad esempio, l’esecuzione di un GET richiesta di /content/cq:graphql/global/endpoint.GQLschema si tradurrà nell'output dello schema con il tipo di contenuto: text/x-graphql-schema;charset=iso-8859-1.

Generazione schema - Modelli non pubblicati

Quando i frammenti di contenuto sono nidificati, può accadere che un modello di frammento di contenuto principale venga pubblicato, ma non lo è un modello di riferimento.

NOTA

L’interfaccia utente AEM impedisce che ciò accada, ma se la pubblicazione viene effettuata a livello di programmazione o con pacchetti di contenuto può verificarsi.

In questo caso, AEM genera un incompleto Schema per il modello di frammento di contenuto principale. Ciò significa che il Riferimento frammento, che dipende dal modello non pubblicato, viene rimosso dallo schema.

espandibili

Nello schema sono presenti singoli campi, di due categorie di base:

  • Campi generati.

    Selezione di Tipi di campi vengono utilizzati per creare campi in base alla modalità di configurazione del modello di frammento di contenuto. I nomi dei campi vengono ricavati dal Nome proprietà campo Tipo di dati.

    • C'è anche la Rendering come proprietà da prendere in considerazione, in quanto gli utenti possono configurare determinati tipi di dati; ad esempio, come testo a riga singola o come campo multiplo.
  • GraphQL per AEM genera anche una serie di campi di supporto.

    Vengono utilizzati per identificare un frammento di contenuto o per ottenere ulteriori informazioni su un frammento di contenuto.

Tipi di campi

GraphQL per AEM supporta un elenco di tipi. Sono rappresentati tutti i tipi di dati dei modelli di frammento di contenuto supportati e i corrispondenti tipi GraphQL:

Modello per frammento di contenuto - Tipo di dati Tipo GraphQL Descrizione
Testo a riga singola Stringa, [Stringa] Utilizzato per stringhe semplici come nomi di autore, nomi di posizione, ecc.
Testo a più righe Stringa Utilizzato per l’output di testo, ad esempio il corpo di un articolo
Numero Mobile, [Mobile] Utilizzato per visualizzare il numero a virgola mobile e i numeri regolari
Booleano Booleano Utilizzato per visualizzare le caselle di controllo → semplici istruzioni true/false
Data E Ora Calendario Utilizzato per visualizzare data e ora in formato ISO 8086. A seconda del tipo selezionato, sono disponibili tre aromi da utilizzare in AEM GraphQL: onlyDate, onlyTime, dateTime
Enumerazione Stringa Utilizzato per visualizzare un'opzione da un elenco di opzioni definite durante la creazione del modello
Tag [Stringa] Utilizzato per visualizzare un elenco di stringhe che rappresentano tag utilizzati in AEM
Riferimento contenuto Stringa Utilizzato per visualizzare il percorso verso un’altra risorsa in AEM
Riferimento frammento Un tipo di modello Utilizzato per fare riferimento a un altro frammento di contenuto di un determinato tipo di modello, definito al momento della creazione del modello

Campi helper

Oltre ai tipi di dati per i campi generati dall’utente, GraphQL per AEM genera anche una serie di aiutante per facilitare l’identificazione di un frammento di contenuto o per fornire informazioni aggiuntive su un frammento di contenuto.

Percorso

Il campo percorso viene utilizzato come identificatore in GraphQL. Rappresenta il percorso della risorsa Frammento di contenuto all’interno dell’archivio AEM. Questo è l’identificatore di un frammento di contenuto, in quanto:

  • è univoco all'interno di AEM,
  • può essere facilmente recuperato.

Il codice seguente visualizza i percorsi di tutti i frammenti di contenuto creati in base al modello di frammento di contenuto Person.

{
  personList {
    items {
      _path
    }
  }
}

Per recuperare un singolo frammento di contenuto di un tipo specifico, è necessario anche determinarne prima il percorso. ad esempio:

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

Vedi Query Di Esempio - Un Singolo Frammento Di Città Specifico.

Metadati

Tramite GraphQL, AEM espone anche i metadati di un frammento di contenuto. I metadati sono informazioni che descrivono un frammento di contenuto, ad esempio il titolo di un frammento di contenuto, il percorso delle miniature, la descrizione di un frammento di contenuto, la data di creazione, tra gli altri.

Poiché i metadati vengono generati tramite l’Editor di schema e in quanto tali non dispongono di una struttura specifica, il TypedMetaData Il tipo GraphQL è stato implementato per esporre i metadati di un frammento di contenuto. TypedMetaData espone le informazioni raggruppate per i seguenti tipi scalari:

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

Ogni tipo scalare rappresenta una coppia nome-valore singola o una matrice di coppie nome-valore, in cui il valore di tale coppia è del tipo in cui è stato raggruppato.

Ad esempio, se desideri recuperare il titolo di un frammento di contenuto, questa proprietà è una proprietà String , quindi eseguiamo una query per tutti i metadati stringa:

Per eseguire una query per i metadati:

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

Puoi visualizzare tutti i tipi di metadati GraphQL se visualizzi lo schema GraphQL generato. Tutti i tipi di modello hanno lo stesso TypedMetaData.

NOTA

Differenza tra i metadati normali e quelli dell'array
Nota bene StringMetadata e StringArrayMetadata entrambi si riferiscono a ciò che è memorizzato nell’archivio, non a come lo si recupera.

Ad esempio, chiamando il stringMetadata riceveresti un array di tutti i metadati memorizzati nel repository come String e se si chiama stringArrayMetadata riceveresti un array di tutti i metadati memorizzati nel repository come String[].

Vedi Esempio di query per metadati - Elenco dei metadati per i riconoscimenti denominati GB.

Varianti

La _variations è stato implementato per semplificare la query delle varianti di un frammento di contenuto. Esempio:

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

Vedi Query di esempio - Tutte le città con una variante denominata.

Variabili GraphQL

GraphQL consente di inserire le variabili nella query. Per ulteriori informazioni, consulta la sezione Documentazione GraphQL per le variabili.

Ad esempio, per ottenere tutti i frammenti di contenuto di tipo Article che hanno una variante specifica, puoi specificare la variabile variation in GraphiQL.

Variabili GraphQL

### query
query GetArticlesByVariation($variation: String!) {
    articleList(variation: $variation) {
        items {
            _path
            author
        }
    }
}
 
### in query variables
{
    "variation": "uk"
}

Direttive GraphQL

In GraphQL è possibile modificare la query in base alle variabili, denominate Direttive GraphQL.

Ad esempio, in questo caso puoi includere il adventurePrice in una query per tutti gli AdventureModels, basato su una variabile includePrice.

Direttive GraphQL

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

Filtro

È inoltre possibile utilizzare il filtro nelle query GraphQL per restituire dati specifici.

Il filtro utilizza una sintassi basata su operatori logici ed espressioni.

Ad esempio, la seguente query (di base) filtra tutte le persone con un nome di Jobs o Smith:

query {
  personList(filter: {
    name: {
      _logOp: OR
      _expressions: [
        {
          value: "Jobs"
        },
        {
          value: "Smith"
        }
      ]
    }
  }) {
    items {
      name
      firstName
    }
  }
}

Per ulteriori esempi, consulta:

GraphQL per AEM - Riepilogo delle estensioni

Il funzionamento di base delle query con GraphQL per AEM rispettare la specifica GraphQL standard. Per le query GraphQL con AEM sono disponibili alcune estensioni:

Query persistenti (memorizzazione in cache)

Dopo aver preparato una query con una richiesta POST, può essere eseguita con una richiesta GET memorizzabile nella cache tramite cache HTTP o CDN.

Questo è necessario in quanto le query POST di solito non vengono memorizzate nella cache e se si utilizza GET con la query come parametro esiste un rischio significativo che il parametro diventi troppo grande per i servizi HTTP e gli intermediari.

Le query persistenti devono sempre utilizzare l'endpoint correlato al configurazione Sites appropriata; in modo che possano utilizzare una delle due opzioni, oppure entrambe:

  • Configurazione globale ed endpoint La query ha accesso a tutti i modelli di frammenti di contenuto.
  • Configurazione o endpoint di Sites specifici La creazione di una query persistente per una configurazione di Sites specifica richiede un endpoint specifico per la configurazione di Sites corrispondente (per fornire accesso ai relativi modelli di frammenti di contenuto).
    Ad esempio, per creare una query persistente specifica per la configurazione di WKND Sites, è necessario creare in anticipo una configurazione di Sites specifica per WKND corrispondente e un endpoint specifico per WKND.
NOTA

Vedi Abilitare la funzionalità dei frammenti di contenuto nel browser di configurazione per ulteriori dettagli.

La Query di persistenza GraphQL deve essere abilitato per la configurazione Sites appropriata.

Ad esempio, se è presente una particolare query denominata my-query, che utilizza un modello my-model dalla configurazione Sites my-conf:

  • Puoi creare una query utilizzando my-conf endpoint specifico, quindi la query verrà salvata come segue:
    /conf/my-conf/settings/graphql/persistentQueries/my-query
  • Puoi creare la stessa query utilizzando global endpoint, ma la query verrà salvata come segue:
    /conf/global/settings/graphql/persistentQueries/my-query
NOTA

Queste sono due query diverse - salvate in percorsi diversi.

Usano lo stesso modello, ma attraverso endpoint diversi.

Di seguito sono riportati i passaggi necessari per mantenere una determinata query:

  1. Prepara la query inserendola nel nuovo URL dell’endpoint /graphql/persist.json/<config>/<persisted-label>.

    Ad esempio, crea una query persistente:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
        }
      }
    }'
    
  2. A questo punto, controlla la risposta.

    Ad esempio, controlla il successo:

    {
      "action": "create",
      "configurationName": "wknd",
      "name": "plain-article-query",
      "shortPath": "/wknd/plain-article-query",
      "path": "/conf/wknd/settings/graphql/persistentQueries/plain-article-query"
    }
    
  3. È quindi possibile riprodurre nuovamente la query persistente utilizzando GETing l'URL /graphql/execute.json/<shortPath>.

    Ad esempio, utilizza la query persistente:

    $ curl -X GET \
        http://localhost:4502/graphql/execute.json/wknd/plain-article-query
    
  4. Aggiornare una query persistente tramite POSTing a un percorso di query già esistente.

    Ad esempio, utilizza la query persistente:

    $ curl -X POST \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
          referencearticle {
            _path
          }
        }
      }
    }'
    
  5. Crea una query normale con wrapping.

    Esempio:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-wrapped" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }"}'
    
  6. Crea una query normale con wrapping con il controllo della cache.

    Esempio:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
    
  7. Crea una query persistente con parametri:

    Esempio:

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-parameters" \
        -d \
    'query GetAsGraphqlModelTestByPath($apath: String!, $withReference: Boolean = true) {
      articleByPath(_path: $apath) {
        item {
          _path
            author
            main {
            plaintext
            }
            referencearticle @include(if: $withReference) {
            _path
            }
          }
        }
      }'
    
  8. Esecuzione di una query con parametri.

    Esempio:

    $ curl -X POST \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/execute.json/wknd/plain-article-query-parameters;apath=%2fcontent2fdam2fwknd2fen2fmagazine2falaska-adventure2falaskan-adventures;withReference=false"
    
    $ curl -X GET \
        "http://localhost:4502/graphql/execute.json/wknd/plain-article-query-parameters;apath=%2fcontent2fdam2fwknd2fen2fmagazine2falaska-adventure2falaskan-adventures;withReference=false"
    
  9. Per eseguire la query al momento della pubblicazione, la struttura ad albero persistente correlata deve essere replicata

    • Utilizzo di un POST per la replica:

      $curl -X POST   http://localhost:4502/bin/replicate.json \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -F path=/conf/wknd/settings/graphql/persistentQueries/plain-article-query \
        -F cmd=activate
      
    • Utilizzando un pacchetto:

      1. Crea una nuova definizione di pacchetto.
      2. Includi la configurazione (ad esempio, /conf/wknd/settings/graphql/persistentQueries).
      3. Crea il pacchetto.
      4. Replicare il pacchetto.
    • Utilizzo dello strumento di replica/distribuzione.

      1. Passa allo strumento Distribuzione .
      2. Seleziona l’attivazione ad albero per la configurazione (ad esempio, /conf/wknd/settings/graphql/persistentQueries).
    • Utilizzo di un flusso di lavoro (tramite la configurazione del modulo di avvio del flusso di lavoro):

      1. Definisci una regola di avvio del flusso di lavoro per l’esecuzione di un modello di flusso di lavoro che replichi la configurazione su eventi diversi (ad esempio, crea, modifica, tra gli altri).
  10. Quando la configurazione della query è attiva per la pubblicazione, si applicano gli stessi principi, utilizzando solo l’endpoint di pubblicazione.

    NOTA

    Per l'accesso anonimo il sistema presuppone che l'ACL consenta a "tutti" di avere accesso alla configurazione della query.

    In caso contrario, non potrà essere eseguito.

    NOTA

    Eventuali punti e virgola (";") negli URL devono essere codificati.

    Ad esempio, come nella richiesta di eseguire una query persistente:

    curl -X GET \ "http://localhost:4502/graphql/execute.json/wknd/plain-article-query-parameters%3bapath=%2fcontent2fdam2fwknd2fen2fmagazine2falaska-adventure2falaskan-adventures;withReference=false"
    

Query dell’endpoint GraphQL da un sito Web esterno

Per accedere all’endpoint GraphQL da un sito web esterno è necessario configurare i seguenti elementi:

Filtro CORS

NOTA

Per una panoramica dettagliata della politica di condivisione delle risorse CORS in AEM vedi Comprendere la condivisione delle risorse tra le origini (CORS, Cross-Origin Resource Sharing).

Per accedere all’endpoint GraphQL, è necessario configurare un criterio CORS nell’archivio Git del cliente. Questo viene fatto aggiungendo un file di configurazione OSGi CORS appropriato per gli endpoint desiderati.

Questa configurazione deve specificare un'origine sito Web attendibile alloworigin o alloworiginregexp per i quali deve essere concesso l'accesso.

Ad esempio, per concedere l’accesso all’endpoint GraphQL e all’endpoint per le query persistenti per https://my.domain puoi utilizzare:

{
  "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/.*"
  ]
}

Se hai configurato un percorso personalizzato per l’endpoint, puoi anche utilizzarlo in allowedpaths.

Filtro di riferimento

Oltre alla configurazione CORS, è necessario configurare un filtro Referrer per consentire l’accesso da host di terze parti.

A questo scopo, aggiungi un file di configurazione OSGi Referrer Filter appropriato che:

  • specifica un nome host del sito web fidato; o allow.hosts o allow.hosts.regexp,
  • concede l'accesso per questo nome host.

Ad esempio, per concedere l’accesso alle richieste con il referente my.domain puoi:

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

Spetta al cliente:

  • concedere solo l'accesso ai domini trusted
  • assicurati che non siano esposte informazioni sensibili
  • non utilizzare un carattere jolly [*] sintassi; entrambi disattiveranno l’accesso autenticato all’endpoint GraphQL e lo esporranno a tutto il mondo.
ATTENZIONE

Tutti i GraphQL schemi (derivato dai modelli di frammenti di contenuto che sono stati Abilitato) sono leggibili attraverso l’endpoint GraphQL .

Ciò significa che devi assicurarti che non siano disponibili dati sensibili, in quanto potrebbero essere trapelati in questo modo; ad esempio, include informazioni che potrebbero essere presenti come nomi di campo nella definizione del modello.

Autenticazione

Vedi Autenticazione per query GraphQL AEM remote su frammenti di contenuto.

Domande frequenti

Domande sollevate:

  1. Q: "In che modo l’API GraphQL per AEM è diversa dall’API di Query Builder?"

    • A: "L’API GraphQL di AEM offre il controllo totale sull’output JSON ed è uno standard di settore per l’esecuzione di query sui contenuti.
      In futuro, AEM prevede di investire nell’API GraphQL AEM.
      "

Tutorial: guida introduttiva a AEM Headless e GraphQL

Stai cercando un tutorial pratico? Consulta Guida introduttiva a AEM Headless e GraphQL esercitazione end-to-end che illustra come creare ed esporre contenuti utilizzando le API GraphQL di AEM e utilizzati da un’app esterna, in uno scenario CMS headless.

In questa pagina