Creare una richiesta API - Configurazione headless

Scopri come utilizzare l’API GraphQL per la distribuzione headless di contenuti con frammenti di contenuto e API REST di Assets di AEM per gestire i frammenti di contenuto.

NOTA

Alcune delle funzionalità di questa caratteristica sono disponibili nel canale prerelease. In particolare, funzionalità relative alle query persistenti.

Consulta la sezione Documentazione sul canale prerelease per informazioni su come abilitare la funzione per il tuo ambiente.

Cosa sono le API REST di GraphQL e Assets?

Dopo aver creato alcuni frammenti di contenuto, puoi utilizzare le API AEM per distribuirle senza problemi.

Il resto di questa guida sarà incentrato sull’accesso a GraphQL e la distribuzione di frammenti di contenuto.

Abilitare endpoint GraphQL

Prima di poter utilizzare le API GraphQL, è necessario creare un endpoint GraphQL.

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

  2. Seleziona Crea.

  3. Si aprirà la finestra di dialogo Crea nuovo endpoint GraphQL. Qui potrai definire:

    • Nome: nome dell’endpoint; puoi immettere qualsiasi testo.
    • Utilizza lo schema GraphQL fornito da: utilizza il menu a discesa per selezionare la configurazione richiesta.
  4. Conferma con Crea.

  5. Nella console verrà ora visualizzato un Percorso in base alla configurazione creata in precedenza. Questo è il percorso utilizzato per eseguire le query GraphQL.

    /content/cq:graphql/<configuration-name>/endpoint
    

Ulteriori dettagli sull’abilitazione degli endpoint GraphQL si trovano qui.

Query del contenuto tramite GraphQL con GraphiQL

Gli architetti di informazioni dovranno progettare query per i loro endpoint di canale per distribuire contenuti. In genere queste query devono essere considerate solo una volta per endpoint per modello. Ai fini di questa guida introduttiva, è sufficiente crearne una.

GraphiQL è un IDE che può essere installato in un ambiente AEM. Segui i passaggi su Utilizzo di IDE GraphiQL per eseguire l’installazione nell’ambiente AEM.

  1. Accedi AEM as a Cloud Service e accedi all’interfaccia GraphiQL:

    Puoi accedere all’editor delle query da:

    • Strumenti -> Generale -> Editor query GraphQL
    • direttamente; ad esempio, http://localhost:4502/aem/graphiql.html
  2. L’IDE GraphiQL è un editor di query interno al browser per GraphQL. Puoi utilizzarlo per creare query per recuperare frammenti di contenuto da distribuire in modalità headless come JSON.

    • L’elenco a discesa in alto a destra consente di selezionare l’endpoint.
    • L’ultimo pannello a sinistra elenca le query persistenti (se disponibili)
    • Il pannello nella parte centrale sinistra ti consente di creare la query.
    • Nel pannello centrale di destra vengono visualizzati i risultati.
    • L’editor delle query dispone del completamento del codice e dei tasti di scelta rapida per eseguire facilmente la query.

    Editor GraphiQL

  3. Supponendo che il modello che abbiamo creato si chiama person con campi firstName, lastName e position, possiamo creare una semplice query per recuperare il contenuto del frammento di contenuto.

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. Inserisci la query nel pannello a sinistra.
    Query GraphiQL

  5. Fai clic sul pulsante Esegui query o utilizza il tasto di scelta rapida Ctrl-Enter e i risultati vengono visualizzati come JSON nel pannello di destra.
    Risultati GraphiQL

  6. Fai clic sul collegamento Documenti in alto a destra della pagina per visualizzare la documentazione contestuale per aiutarti a creare le query che si adattano ai tuoi modelli.
    Documentazione di GraphiQL

GraphQL consente query strutturate in grado di eseguire il targeting non solo di set di dati specifici o di singoli oggetti di dati, ma anche di fornire elementi specifici degli oggetti, risultati nidificati, offerte di supporto per variabili di query e molto altro.

GraphQL può evitare richieste API iterative e consegna in eccesso, e consente invece la distribuzione in massa di esattamente ciò che è necessario per il rendering come risposta a una singola query API. Il JSON risultante può essere utilizzato per inviare dati ad altri siti o app.

Passaggi successivi

Tutto qui. Ora hai una conoscenza di base della gestione dei contenuti headless in AEM. Naturalmente, sono disponibili molte altre risorse da approfondire per una comprensione completa delle funzioni disponibili.

In questa pagina