Esplorare le API GraphQL

L’API GraphQL di AEM fornisce un potente linguaggio di query per esporre i dati dei frammenti di contenuto alle applicazioni a valle. I modelli di frammenti di contenuto definiscono lo schema di dati utilizzato dai frammenti di contenuto. Ogni volta che viene creato o aggiornato un modello di frammento di contenuto, lo schema viene tradotto e aggiunto al "grafico" che costituisce l’API GraphQL.

In questo capitolo vengono esplorate alcune query GraphQL comuni per raccogliere contenuti utilizzando un IDE chiamato GraphiQL. L'IDE GraphiQL ti consente di testare e perfezionare rapidamente le query e i dati restituiti. Offre inoltre un facile accesso alla documentazione, facilitando l’apprendimento e la comprensione dei metodi disponibili.

Prerequisiti

Si tratta di un tutorial in più parti e si presume che i passaggi descritti in Authoring di frammenti di contenuto sono state completate.

Obiettivi

  • Scopri come utilizzare lo strumento GraphiQL per creare una query utilizzando la sintassi GraphQL.
  • Scopri come eseguire una query su un elenco di frammenti di contenuto e un singolo frammento di contenuto.
  • Scopri come filtrare e richiedere attributi di dati specifici.
  • Scopri come unire una query di più modelli di frammenti di contenuto
  • Scopri come mantenere la query GraphQL.

Abilitare endpoint GraphQL

È necessario configurare un endpoint GraphQL per abilitare le query API GraphQL per i frammenti di contenuto.

  1. Dalla schermata iniziale AEM, passa a Strumenti > Generale > GraphQL.

    Passa all’endpoint GraphQL

  2. Tocca Crea nell’angolo in alto a destra, nella finestra di dialogo risultante immetti i seguenti valori:

    • Nome*: Endpoint progetto personale.
    • Utilizza lo schema GraphQL fornito da … *: Progetto personale

    Crea endpoint GraphQL

    Tocca Crea per salvare l’endpoint.

    Gli endpoint GraphQL creati in base a una configurazione di progetto abilitano solo le query per i modelli appartenenti a tale progetto. In questo caso, le uniche query contro Persona e Team è possibile utilizzare modelli.

    NOTA

    È inoltre possibile creare un endpoint globale per abilitare le query sui modelli in più configurazioni. Questo dovrebbe essere utilizzato con cautela in quanto potrebbe aprire l’ambiente a ulteriori vulnerabilità di sicurezza e aggiungere alla complessità complessiva nella gestione dei AEM.

  3. Ora dovresti vedere un endpoint GraphQL abilitato nell’ambiente.

    Endpoint graphql abilitati

Utilizzo dell’IDE GraphiQL

La GraphiQL lo strumento consente agli sviluppatori di creare e testare query rispetto al contenuto nell’ambiente AEM corrente. Lo strumento GraphiQL consente inoltre agli utenti di persistere o salvare le query che devono essere utilizzate dalle applicazioni client in un'impostazione di produzione.

Quindi, scopri la potenza dell’API GraphQL AEM utilizzando l’IDE GraphiQL integrato.

  1. Dalla schermata iniziale AEM, passa a Strumenti > Generale > Editor query GraphQL.

    Passa all'IDE GraphiQL

    NOTA

    In potrebbero non essere integrate le versioni precedenti di AEM dell'IDE GraphiQL. Può essere installato manualmente seguendo questi istruzioni.

  2. Nell’angolo in alto a destra, assicurati che l’endpoint sia impostato su Endpoint progetto personale.

    Imposta endpoint GraphQL

In questo modo tutte le query verranno estese ai modelli creati nella Progetto personale progetto.

Query di un elenco di frammenti di contenuto

Un requisito comune consiste nell’eseguire query per più frammenti di contenuto.

  1. Incolla la seguente query nel pannello principale (sostituendo l’elenco dei commenti):

    query allTeams {
      teamList {
        items {
          _path
          title
        }
      }
    }
    
  2. Premere Play nel menu principale per eseguire la query. Dovresti visualizzare i risultati dei frammenti di contenuto del capitolo precedente:

    Risultati elenco persone

  3. Posizionare il cursore sotto il title testo e immetti CTRL+Spazio per attivare i suggerimenti sul codice. Aggiungi shortname e description alla query.

    Aggiorna query con hash di codice

  4. Esegui nuovamente la query premendo il pulsante Play e dovresti vedere che i risultati includono le proprietà aggiuntive di shortname e description.

    nome e descrizione dei risultati

    La shortname è una proprietà semplice e description è un campo di testo su più righe e l’API GraphQL ci consente di scegliere vari formati per i risultati, come html, markdown, jsonoppure plaintext.

Query per frammenti nidificati

Successivamente, l'esperimento con l'esecuzione di query consiste nel recupero dei frammenti nidificati, ricorda che l' Team il modello fa riferimento a Persona modello.

  1. Aggiorna la query per includere la teamMembers proprietà. Ricorda che si tratta di un Riferimento frammento al modello persona. È possibile restituire le proprietà del modello Persona:

    query allTeams {
        teamList {
            items {
                _path
                title
                shortName
                description {
                    plaintext
                }
                teamMembers {
                    fullName
                    occupation
                }
            }
        }
    }
    

    Risposta JSON:

    {
        "data": {
            "teamList": {
            "items": [
                {
                "_path": "/content/dam/my-project/en/team-alpha",
                "title": "Team Alpha",
                "shortName": "team-alpha",
                "description": {
                    "plaintext": "This is a description of Team Alpha!"
                },
                "teamMembers": [
                    {
                    "fullName": "John Doe",
                    "occupation": [
                        "Artist",
                        "Influencer"
                    ]
                    },
                    {
                    "fullName": "Alison Smith",
                    "occupation": [
                        "Photographer"
                    ]
                    }
                  ]
            }
            ]
            }
        }
    }
    

    La capacità di eseguire query sui frammenti nidificati è una funzione potente dell’API GraphQL AEM. In questo semplice esempio, la nidificazione è profonda solo due livelli. Tuttavia è possibile nidificare ulteriormente i frammenti. Ad esempio, se è presente un Indirizzo modello associato a un Persona sarebbe possibile restituire i dati di tutti e tre i modelli in un’unica query.

Filtrare un elenco di frammenti di contenuto

Ora, vediamo come è possibile filtrare i risultati in un sottoinsieme di frammenti di contenuto in base a un valore di proprietà.

  1. Immetti la seguente query nell’interfaccia utente GraphiQL:

    query personByName($name:String!){
      personList(
        filter:{
          fullName:{
            _expressions:[{
              value:$name
              _operator:EQUALS
            }]
          }
        }
      ){
        items{
          _path
          fullName
          occupation
        }
      }
    }
    

    La query di cui sopra esegue una ricerca per tutti i frammenti Persona nel sistema. Il filtro aggiunto all’inizio della query esegue un confronto sui name e la stringa della variabile $name.

  2. In Variabili di query inserisci quanto segue:

    {"name": "John Doe"}
    
  3. Esegui la query, è previsto che solo Persone Il frammento di contenuto viene restituito con un valore di John Doe.

    Utilizzare le variabili di query per filtrare

    Esistono molte altre opzioni per filtrare e creare query complesse, vedi Imparare a utilizzare GraphQL con AEM - Contenuto di esempio e query.

  4. Ottimizza la query di cui sopra per recuperare l’immagine del profilo

    query personByName($name:String!){
      personList(
        filter:{
          fullName:{
            _expressions:[{
              value:$name
              _operator:EQUALS
            }]
          }
        }
      ){
        items{
          _path
          fullName
          occupation
          profilePicture{
            ... on ImageRef{
              _path
              _authorUrl
              _publishUrl
              height
              width
    
            }
          }
        }
      }
    }
    

    La profilePicture è un riferimento al contenuto e si prevede che sia un'immagine, quindi incorporato ImageRef viene utilizzato l'oggetto . Questo ci consente di richiedere dati aggiuntivi sull'immagine a cui fare riferimento, come il width e height.

Eseguire una query su un singolo frammento di contenuto

È inoltre possibile eseguire query dirette su un singolo frammento di contenuto. Il contenuto in AEM viene memorizzato in modo gerarchico e l’identificatore univoco di un frammento è basato sul percorso del frammento.

  1. Immetti la seguente query nell'editor GraphiQL:

    query personByPath($path: String!) {
        personByPath(_path: $path) {
            item {
            fullName
            occupation
            }
        }
    }
    
  2. Immetti quanto segue per il Variabili di query:

    {"path": "/content/dam/my-project/en/alison-smith"}
    
  3. Esegui la query e osserva che viene restituito il singolo risultato.

Query permanenti

Una volta che uno sviluppatore è soddisfatto dei dati della query e dei risultati restituiti dalla query, il passaggio successivo consiste nell’archiviare o mantenere la query in AEM. La Query persistenti sono il meccanismo preferito per l’esposizione dell’API GraphQL alle applicazioni client. Una volta che una query è persistente, può essere richiesta utilizzando una richiesta GET e memorizzata nella cache ai livelli Dispatcher e CDN. Le prestazioni delle query persistenti sono molto migliori. Oltre ai vantaggi in termini di prestazioni, le query persistenti garantiscono che i dati aggiuntivi non siano accidentalmente esposti alle applicazioni client. Maggiori dettagli Le query persistenti si trovano qui.

Successivamente, persistono due semplici query, che vengono utilizzate nel capitolo successivo.

  1. Immetti la seguente query nell'IDE GraphiQL:

    query allTeams {
        teamList {
            items {
                _path
                title
                shortName
                description {
                    plaintext
                }
                teamMembers {
                    fullName
                    occupation
                }
            }
        }
    }
    

    Verifica che la query funzioni.

  2. Tocca successivo Salva con nome e immetti all-teams come Nome query.

    La query deve essere visualizzata in Query persistenti nella barra a sinistra.

    Query persistente per tutti i team

  3. Toccare quindi i puntini di sospensione accanto alla query persistente e toccare Copia URL per copiare il percorso negli Appunti.

    Copia URL query persistente

  4. Apri una nuova scheda e incolla il percorso copiato nel browser:

    https://$YOUR-AEMasCS-INSTANCEID$.adobeaemcloud.com/graphql/execute.json/my-project/all-teams
    

    Dovrebbe essere simile al percorso indicato sopra. Dovresti vedere che sono stati restituiti i risultati JSON della query.

    Scomposizione dell’URL precedente:

    Nome Descrizione
    /graphql/execute.json Endpoint di query persistente
    /my-project Configurazione del progetto per /conf/my-project
    /all-teams Nome della query persistente
  5. Torna all'IDE GraphiQL e utilizza il pulsante più + per mantenere la query NEW

    query personByName($name: String!) {
      personList(
        filter: {
          fullName:{
            _expressions: [{
              value: $name
              _operator:EQUALS
            }]
          }
        }){
        items {
          _path
          fullName
          occupation
          biographyText {
            json
          }
          profilePicture {
            ... on ImageRef {
              _path
              _authorUrl
              _publishUrl
              width
              height
            }
          }
        }
      }
    }
    
  6. Salva la query come: person-by-name.

  7. È necessario salvare due query persistenti:

    Query persistenti finali

Pubblica endpoint GraphQL e query persistenti

Al momento della revisione e della verifica, pubblica il GraphQL Endpoint & Persisted Queries

  1. Dalla schermata iniziale AEM, passa a Strumenti > Generale > GraphQL.

  2. Tocca la casella di controllo accanto a Endpoint progetto personale e toccare Pubblica

    Pubblica endpoint GraphQL

  3. Dalla schermata iniziale AEM, passa a Strumenti > Generale > Editor query GraphQL

  4. Tocca all-team query dal pannello Query persistenti e tocca Pubblica

    Pubblicare query persistenti

  5. Ripeti il passaggio precedente per person-by-name query

File della soluzione

Scarica il contenuto, i modelli e le query persistenti create negli ultimi tre capitoli: tutorial-solution-content.zip

Risorse aggiuntive

Ulteriori informazioni sulle query GraphQL in Imparare a utilizzare GraphQL con AEM - Contenuto di esempio e query.

Congratulazioni!

Congratulazioni, hai creato ed eseguito diverse query GraphQL!

Passaggi successivi

Nel capitolo successivo, Creare un’app React, puoi esplorare come un’applicazione esterna può eseguire query AEM endpoint GraphQL e utilizzare queste due query persistenti. Viene inoltre introdotta una gestione degli errori di base durante l’esecuzione delle query GraphQL.

Installare lo strumento GraphiQL (facoltativo)

In, alcune versioni di AEM (6.X.X) lo strumento GraphiQL IDE deve essere installato manualmente, utilizza le seguenti istruzioni:

  1. Vai a Portale di distribuzione software > AEM as a Cloud Service.

  2. Cerca “GraphiQL” (assicurati di includere i in GraphiQL.

  3. Scarica la versione più recente del pacchetto di contenuti GraphiQL v.x.x.x

    Scarica il pacchetto GraphiQL

    Il file zip è un pacchetto AEM che può essere installato direttamente.

  4. Dal menu Start AEM, passa a Strumenti > Distribuzione > Pacchetti.

  5. Fai clic su Carica pacchetto, quindi seleziona il pacchetto scaricato nel passaggio precedente. Per installare il pacchetto, fai clic su Installa.

    Installa pacchetto GraphiQL

In questa pagina