Creare una richiesta API - Configurazione headless accessing-delivering-content-fragments

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.

Cosa sono le API REST di GraphQL e Assets? what-are-the-apis

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

Il resto di questa guida è incentrato sull’accesso a GraphQL e sulla distribuzione di frammenti di contenuto.

Abilitare endpoint GraphQL enable-graphql-endpoint

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 apre 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 l’elenco a discesa per selezionare la configurazione richiesta.
  4. Conferma con Crea.

  5. Nella console viene visualizzato un Percorso in base alla configurazione creata in precedenza. Questo percorso viene utilizzato per eseguire le query GraphQL.

    code language-none
    /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 progettano query per i loro endpoint di canale per distribuire contenuti. Prendi in considerazioni queste query una sola volta per endpoint, per modello. Ai fini di questa guida introduttiva, è sufficiente crearne una.

GraphiQL è un IDE, incluso nel tuo ambiente AEM e accessibile/visibile dopo aver configurato gli endpoint.

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

    Puoi accedere all’editor delle query da:

    • Strumenti > Generale > Editor query di 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 centrale a sinistra 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 hai creato si chiama person con campi firstName, lastName e position, puoi creare una semplice query per recuperare il contenuto del frammento di contenuto.

    code language-text
    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. Nell’angolo superiore a destra della pagina, fai clic sul collegamento Documenti per visualizzare la documentazione contestuale, in modo da creare query adatte 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 consegne in eccesso, e consente invece la distribuzione in massa esattamente di 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 next-steps

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

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab