API GraphQL AEM per l’utilizzo con Frammenti di contenuto

Scopri come utilizzare Frammenti di contenuto in Adobe Experience Manager (AEM) as a Cloud Service con l’API GraphQL AEM per la consegna di contenuti headless.

L’API GraphQL AEM as a Cloud Service utilizzata con i Frammenti di contenuto è pesantemente basata sull’API GraphQL standard open source.

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

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

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 abilita potenti strumenti per gli sviluppatori.”.

  Vedi GraphQL.org

• “…una specifica aperta per un livello API flessibile. Posiziona GraphQL sui backend esistenti per costruire 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 resi open source nel 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 in produzione da centinaia di organizzazioni di tutte le dimensioni…”

  Vedi GraphQL Foundation.

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

• In graphql.org:

  • Introduzione a GraphQL

  • Specifiche GraphQL

• In graphql.com:

  • Guide

  • Esercitazioni

  • Casi di studio

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

• graphQL.org - Java

• Java GraphQL su GitHub

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 GraphQL per AEM.

• Campi

• Endpoint GraphQL

  • Il percorso in AEM che risponde alle query GraphQL e fornisce accesso agli schemi GraphQL.

  • Consulta Abilitazione dell’endpoint GraphQL per ulteriori dettagli.

Consulta(GraphQL.org) Introduzione a GraphQL per informazioni complete, che comprendono le Best practice.

Tipi di query GraphQL

Con GraphQL è possibile eseguire query per ottenere:

• Un ingresso singolo

• Un elenco delle voci

AEM fornisce funzionalità per convertire le query (entrambi i tipi) in Query persistenti, che possono essere memorizzate nella cache da Dispatcher e dalla rete CDN.

Tecniche consigliate per le query GraphQL (Dispatcher e CDN)

La Query persistenti sono il metodo consigliato da utilizzare nelle istanze di pubblicazione come:

• vengono memorizzate nella cache;
• sono gestite centralmente da AEM as a Cloud Service.

Le query GraphQL che utilizzano richieste POST non sono consigliate in quanto non sono memorizzate nella cache, pertanto in un’istanza predefinita Dispatcher è configurato per bloccare tali query.

Anche se GraphQL supporta anche le richieste GET, possono raggiungere i limiti (ad esempio la lunghezza dell’URL) che possono essere evitati utilizzando le query persistenti.

IDE GraphiQL

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

Casi di utilizzo per ambienti di authoring e pubblicazione

I casi di utilizzo possono dipendere dal tipo di ambiente AEM as a Cloud Service:

• ambiente di pubblicazione; utilizzato per:

  • effettuare query sui dati per l’applicazione JS (caso di utilizzo standard)

• ambiente di authoring; utilizzato per:

  • effettuare query sui dati a “scopo di gestione dei contenuti”:
    • GraphQL in AEM as a Cloud Service è 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.

Le query GraphQL vengono eseguite con l'autorizzazione dell'utente AEM della richiesta sottostante. Se l’utente non dispone dell’accesso in lettura ad alcuni frammenti (memorizzati come risorse), non farà parte del set di risultati.

Inoltre, l’utente deve avere accesso a un endpoint GraphQL per poter eseguire query GraphQL.

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 lo Schema, che contiene tutti i tipi necessari per una query.

Per quanto riguarda i Frammenti di contenuto, gli schemi GraphQL (struttura e tipi) sono basati su modelli di Frammenti di contenuto abilitati e i relativi tipi di dati.

Ad esempio, se un utente ha creato un modello di frammento di contenuto denominato Article, quindi AEM genera un tipo GraphQL ArticleModel. I campi all’interno di questo tipo corrispondono ai campi e ai tipi di dati definiti nel modello. Inoltre, crea alcuni punti di ingresso per le query che operano su questo tipo, come articleByPath o articleList.

1. Modello di Frammento di contenuto:

   

2. Lo schema GraphQL corrispondente (output dalla documentazione automatica GraphiQL):
   

   Questo mostra che il tipo ArticleModel generato contiene diversi campi.

   • 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, campi di supporto) _path, _metadata, _variations.

3. Un Frammento di contenuto basato sul modello di articolo creato da un utente può essere interrogato tramite GraphQL. Per esempi, consulta la sezione Query di esempio (basata su una struttura di Frammento 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 rivede un modello di Frammento di contenuto.

Le cache dello schema dati vengono aggiornate anche quando si rivede 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 garantisce stabilità.

Ad esempio, se:

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

   1. vengono generati dei tipi GraphQL per Model-1 e Model-2.

2. Poi modifica Content-Fragment-Model-2:

   1. verrà aggiornato solo il tipo GraphQL Model-2.

   2. Mentre Model-1 rimarrà lo stesso.

Lo schema viene gestito attraverso lo stesso endpoint delle query GraphQL, dove il client gestisce il fatto che lo schema viene chiamato con l’estensione GQLschema. Ad esempio, l’esecuzione di una semplice richiesta GET 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 venga pubblicato un modello di Frammento di contenuto principale, ma non il modello di riferimento.

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

Campi

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

• Campi generati dall’utente.

  Selezione di Tipi di dati 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 scheda .

  • C'è anche la Rendering come , in quanto gli utenti possono configurare determinati tipi di dati. Ad esempio, un campo di testo a riga singola può essere configurato in modo da contenere più testi a riga singola scegliendo multifield dal menu a discesa .

• GraphQL per AEM genera anche una serie di campi di supporto.

Tipi di dati

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

Campi di supporto

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

Tali campi di supporto sono contrassegnati con un _ per distinguere tra ciò che è stato definito dall’utente e ciò che è stato generato automaticamente.

Percorso

Il campo percorso viene utilizzato come identificatore in AEM GraphQL. Rappresenta il percorso della risorsa Frammenti 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 Author, come fornito dall’esercitazione WKND .

{
  authorList {
    items {
      _path
    }
  }
}

Inoltre, per recuperare un singolo frammento di contenuto di un tipo specifico, è necessario determinarne prima il percorso. Esempio:

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

Vedi Query di esempio: un singolo frammento di città specifico.

Metadati

Tramite GraphQL, AEM espone inoltre 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 schemi e, pertanto, non dispongono di una struttura specifica, il tipo di TypedMetaData GraphQL è stato implementato per esporre i metadati di un frammento di contenuto. TypedMetaData espone le informazioni raggruppate per i seguenti tipi scalari:

Ogni tipo scalare rappresenta una coppia nome-valore singola o un array di coppie nome-valore, in cui il valore di tale coppia è del tipo all'interno del quale è stato raggruppato.

Ad esempio, se vuoi recuperare il titolo di un frammento di contenuto, si tratta di una proprietà stringa, pertanto è necessario eseguire una query per tutti i metadati stringa:

Per eseguire una query per i metadati:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _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.

Vedi Query di esempio per metadati: elenca i metadati per riconoscimenti con titolo GB.

Varianti

Il campo _variations è stato implementato per semplificare l’esecuzione delle query sulle varianti di un frammento di contenuto. Esempio:

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

Vedi Query di esempio: tutte le città con una variante denominata.

Variabili GraphQL

GraphQL consente di inserire variabili nella query. Per ulteriori informazioni, consulta la documentazione di GraphQL per variabili.

Ad esempio, per ottenere tutti i frammenti di contenuto di tipo Author in una specifica variante (se disponibile), puoi specificare l’argomento variation in GraphiQL.

Query:

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

Variabili di query:

{
  "variation": "another"
}

Questa query restituirà l’elenco completo degli autori. Autori senza another la variazione torna ai dati originali (_variation riferirà master in questo caso).

Se desideri limitare l’elenco agli autori che forniscono la variante specificata (e saltare gli autori che ritornano ai dati originali), devi applicare un filter:

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

Direttive GraphQL

In GraphQL è possibile modificare le query basate su variabili, denominate Direttive GraphQL.

Ad esempio, puoi includere il campo adventurePrice in una query per tutti i AdventureModels basati su una variabile includePrice.

Query:

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

Variabili di query:

{
    "includePrice": true
}

Filtro

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

Il filtro utilizza una sintassi basata su operatori ed espressioni di tipo logico.

La parte più atomica è una singola espressione che può essere applicata al contenuto di un determinato campo. Confronta il contenuto del campo con un valore costante specificato.

Ad esempio, l'espressione

{
  value: "some text"
  _op: EQUALS
}

confronta il contenuto del campo con il valore some text ed ha successo se il contenuto è uguale al valore . In caso contrario, l’espressione avrà esito negativo.

Le azioni

Per confrontare i campi con un determinato valore è possibile utilizzare i seguenti operatori:

Alcuni tipi consentono inoltre di specificare opzioni aggiuntive che modificano la modalità di valutazione di un’espressione:

Le espressioni possono essere combinate con un set tramite un operatore logico (_logOp):

• OR - il set di espressioni avrà esito positivo se almeno un’espressione avrà esito positivo
• AND - il set di espressioni avrà successo se tutte le espressioni avranno esito positivo (impostazione predefinita)

Ogni campo può essere filtrato in base al proprio set di espressioni. I set di espressioni di tutti i campi menzionati nell’argomento del filtro verranno infine combinati dal proprio operatore logico.

Una definizione di filtro (passata come filter argomento a una query) contiene:

• Una sottodefinizione per ciascun campo (a cui è possibile accedere tramite il suo nome, ad esempio, è disponibile una lastName nel filtro per lastName nel campo Tipo di dati (campo)
• Ogni sottodefinizione contiene la variabile _expressions array, fornendo il set di espressioni e _logOp campo che definisce l’operatore logico con cui combinare le espressioni
• Ciascuna espressione è definita dal valore (value e l'operatore (_operator campo) il contenuto di un campo deve essere confrontato con

È possibile omettere _logOp per combinare gli elementi con AND e _operator se desideri verificare l’uguaglianza, in quanto questi sono i valori predefiniti.

L'esempio seguente illustra una query completa che filtra tutte le persone con una lastName di Provo o contenenti sjö, indipendentemente dal caso:

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

È anche possibile filtrare i campi nidificati, ma non è consigliabile, in quanto potrebbe causare problemi di prestazioni.

Per altri esempi, consulta:

• informazioni dettagliate di GraphQL per estensioni AEM

• Query di esempio che utilizzano il contenuto e la struttura di esempio

  • e il contenuto e la struttura di esempio predisposta per l’utilizzo in query di esempio

• Query di esempio basate sul progetto WKND

Ordinamento

Questa funzione ti consente di ordinare i risultati della query in base a un campo specificato.

I criteri di ordinamento:

• è un elenco di valori separati da virgola che rappresenta il percorso del campo
  • il primo campo dell’elenco definisce l’ordinamento primario, il secondo campo viene utilizzato se due valori del criterio di ordinamento principale sono uguali, il terzo se i primi due criteri sono uguali, ecc.
  • notazione tratteggiata, ad esempio field1.subfield.subfield, ecc.
• con una direzione d'ordine opzionale
  • ASC (crescente) o DESC (decrescente); come ASC predefinito viene applicato
  • la direzione può essere specificata per campo; ciò significa che è possibile ordinare un campo in ordine crescente, un altro in ordine decrescente (nome, nome DESC)

Esempio:

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

Inoltre:

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

È inoltre possibile ordinare in base a un campo all’interno di un frammento nidificato utilizzando il formato nestedFragmentname.fieldname.

Esempio:

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

Paging

Questa funzione consente di eseguire il paging sui tipi di query che restituiscono un elenco. Vengono forniti due metodi:

• offset e limit in List query
• first e after in Paginated query

Query elenco - offset e limite

In una ...Listquery utilizzabile offset e limit per restituire un sottoinsieme specifico di risultati:

• offset: Specifica il primo set di dati da restituire
• limit: Specifica il numero massimo di set di dati da restituire

Ad esempio, per trasmettere la pagina dei risultati contenenti fino a cinque articoli, a partire dal quinto articolo dal completato elenco dei risultati:

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

Query impaginata - prima e dopo

La ...Paginated il tipo di query riutilizza la maggior parte dei ...List funzionalità del tipo di query (filtro, ordinamento), ma non utilizzare offset/limit utilizza first/after argomenti definiti Specifica delle connessioni del cursore GraphQL. È possibile trovare un’introduzione meno formale nella Introduzione a GraphQL.

• first: La n primi elementi da restituire.
  Il valore predefinito è 50.
  Il massimo è 100.
• after: Il cursore che determina l’inizio della pagina richiesta; notare che la voce rappresentata dal cursore non è inclusa nel set di risultati; il cursore di un elemento è determinato dalla cursor campo edges struttura.

Ad esempio, restituisce la pagina dei risultati contenenti fino a cinque avventure, a partire dalla voce del cursore specificata nel completato elenco dei risultati:

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

GraphQL per AEM: riepilogo delle estensioni

Le operazioni di base delle query con GraphQL per AEM sono conformi alle specifiche standard di GraphQL. Per le query GraphQL con AEM sono disponibili alcune estensioni:

• Se prevedi un elenco di risultati:

  • aggiungi List al nome del modello; ad esempio, cityList
  • Vedi Query di esempio: informazioni su tutte le città

  Potete effettuare le seguenti operazioni:

  • Ordinare i risultati

    • ASC : crescente
    • DESC : decrescente

  • Restituisce una pagina di risultati utilizzando:

    • Query elenco con offset e limite
    • Query impaginata con prima e dopo

  • Vedi Query di esempio: informazioni su tutte le città

• Se necessiti di un singolo risultato:

  • utilizza il nome del modello; ad es. città

• Se prevedi un elenco di risultati:

  • aggiungi List al nome del modello; ad esempio, cityList
  • Vedi Query di esempio: informazioni su tutte le città

• Se vuoi utilizzare un operatore OR logico:

  • utilizza _logOp: OR
  • Vedi Query di esempio: tutti gli utenti denominati “Jobs” o “Smith”

• Esiste anche l’operatore AND logico, ma è (spesso) implicito

• Puoi eseguire query sui nomi dei campi corrispondenti ai campi all’interno del modello per frammenti di contenuto

  • Vedi Query di esempio: informazioni complete sull’amministratore delegato e sui dipendenti di un’azienda

• Oltre ai campi del modello, sono disponibili alcuni campi generati dal sistema (preceduti dal carattere di sottolineatura):

  • Per il contenuto:

    • _locale: per visualizzare la lingua; basato su Language Manager

      • Vedi Query di esempio per più frammenti di contenuto di una specifica impostazione locale

    • _metadata: per visualizzare i metadati del frammento

      • Vedi Query di esempio per metadati: elenca i metadati per riconoscimenti con titolo GB

    • _model: consente di eseguire query per un modello per frammenti di contenuto (percorso e titolo)

      • Vedi Query di esempio per un modello per frammenti di contenuto da un modello

    • _path: il percorso del frammento di contenuto all’interno dell’archivio

      • Vedi Query di esempio: un singolo frammento di città specifico

    • _reference: per visualizzare riferimenti; inclusi riferimenti in linea nell’Editor testo RTF

      • Vedi Query di esempio per più frammenti di contenuto con riferimenti di prelettura

    • _variation: per visualizzare varianti specifiche all’interno del frammento di contenuto

      NOTA

      Se per un frammento di contenuto non esiste la variante determinata, la variante principale verrà restituita come impostazione predefinita (fallback).

      • Vedi Query di esempio: tutte le città con una variante denominata

  • E operazioni:

    • _operator: applica operatori specifici; EQUALS, EQUALS_NOT, GREATER_EQUAL, LOWER, CONTAINS, STARTS_WITH
      • Vedi Query di esempio: tutti gli utenti non denominati “Jobs”
      • Vedi Query di esempio: tutte le avventure in cui _path inizia con un prefisso specifico
    • _apply: applica condizioni specifiche; ad esempio, AT_LEAST_ONCE
      • Vedi Query di esempio: applica filtro su un array con un elemento che deve verificarsi almeno una volta
    • _ignoreCase: per ignorare il caso durante la query
      • Vedi Query di esempio: tutte le città che contengono SAN nel nome, indipendentemente da maiuscole/minuscole

• I tipi di unione GraphQL sono supportati:

  • utilizza ... on
    • Vedi Query di esempio per un frammento di contenuto di un modello specifico con un riferimento ai contenuti

• Fallback durante la query dei frammenti nidificati:

  • Se una determinata variante non esiste in un frammento nidificato, viene restituita la variabile principale.

Query dell’endpoint di GraphQL da un sito Web esterno

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

• Filtro CORS
• Filtro referrer

Autenticazione

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

Domande frequenti

Domande poste:

1. D: “quali sono le differenze tra l’API di GraphQL per AEM e l’API di Query Builder?”

   • R:
     “l’API di GraphQL per AEM offre il controllo totale dell’output JSON ed è uno standard di settore per l’esecuzione di query sui contenuti.
     In futuro, AEM prevede di investire nell’API di GraphQL per AEM.”

Tutorial: guida introduttiva ad AEM headless e GraphQL

Cerchi un pratico tutorial? Dai un'occhiata al tutorial Guida introduttiva di headless AEM e GraphQL che illustra come creare ed esporre contenuti, utilizzati da un’app esterna, mediante le API GraphQL di AEM in uno scenario CMS headless.

Risorse Business.Adobe.com