Criar uma solicitação de API - Configuração Headless

Saiba como usar a API GraphQL para a entrega headless do conteúdo do Fragmento de conteúdo e a API REST do AEM Assets para gerenciar Fragmentos de conteúdo.

OBSERVAÇÃO

Parte da funcionalidade desse recurso está disponível no canal de pré-lançamento. Especificamente, a funcionalidade relacionada às consultas persistentes.

Consulte a Documentação do canal de pré-lançamento para obter informações sobre como habilitar o recurso no seu ambiente.

O que são as APIs REST do GraphQL e do Assets?

Agora que criou alguns fragmentos de conteúdo, você pode usar as APIs do AEM para entregá-los de forma headless.

O restante deste guia terá como foco o acesso ao GraphQL e a entrega de Fragmento de conteúdo.

Habilitar endpoint GraphQL

Para que as APIs GraphQL possam ser usadas, é necessário criar um endpoint GraphQL.

  1. Navegar para Ferramentas, Geral, em seguida selecione GraphQL.

  2. Selecione Criar.

  3. A caixa de diálogo Criar novo endpoint de GraphQL será aberta. Aqui, é possível especificar:

    • Nome: nome do endpoint; é possível inserir qualquer texto.
    • Usar esquema GraphQL fornecido por: use a lista suspensa para selecionar a configuração necessária.
  4. Confirme com Criar.

  5. No console, um Caminho será exibido com base na configuração criada anteriormente. Esse é o caminho usado para executar consultas GraphQL.

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

Mais detalhes sobre como ativar endpoints GraphQL podem ser encontrados aqui.

Consultar conteúdo usando GraphQL com o GraphiQL

Os arquitetos da informação precisarão projetar consultas para seus endpoints de canal para fornecer conteúdo. Geralmente, essas consultas só precisarão ser consideradas uma vez por endpoint por modelo. Para os fins deste guia de introdução, só será necessário criar uma.

O GraphiQL é um IDE que pode ser instalado em um ambiente AEM. Siga as etapas em Uso do GraphiQL IDE para instalar no seu ambiente AEM.

  1. Faça logon no AEM as a Cloud Service e acesse a interface GraphiQL:

    Você pode acessar o editor de consultas por meio de:

    • Ferramentas -> Geral -> Editor de consultas GraphQL
    • Diretamente; por exemplo, http://localhost:4502/aem/graphiql.html
  2. O GraphiQL IDE é um editor de consultas no navegador para GraphQL. Você pode usá-lo para criar consultas para recuperar fragmentos de conteúdo e entregá-los como JSON sem periféricos.

    • A lista suspensa no canto superior direito permite selecionar o endpoint.
    • Um painel à esquerda lista as consultas persistentes (quando disponíveis)
    • O painel central esquerdo permite criar a consulta.
    • O painel central direito exibe os resultados.
    • O Editor de consultas tem recursos de autocompletar código e teclas de atalho para executar a consulta com facilidade.

    Editor do GraphiQL

  3. Supondo que o modelo que criamos era chamado person, com os campos firstName, lastName e position, podemos criar uma consulta simples para recuperar o conteúdo do Fragmento de conteúdo.

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. Insira a consulta no painel esquerdo.
    Consulta do GraphiQL

  5. Clique no botão Executar Consulta ou use a tecla de atalho Ctrl-Enter e os resultados serão exibidos como JSON no painel direito.
    Resultados do GraphiQL

  6. Clique no link Documentação na parte superior direita da página para mostrar a documentação contextual para ajudá-lo a criar suas consultas que se adaptam aos seus próprios modelos.
    Documentação do GraphiQL

O GraphQL permite consultas estruturadas que podem direcionar não apenas conjuntos de dados específicos ou objetos de dados individuais, mas também fornecer elementos específicos dos objetos, resultados aninhados, oferecer suporte para variáveis de consulta e muito mais.

O GraphQL pode evitar solicitações de API iterativas, bem como a entrega excessiva e, em vez disso, permite a entrega em massa do que é necessário para renderização como resposta a uma única consulta de API. O JSON resultante pode ser usado para fornecer dados a outros sites ou aplicativos.

Próximas etapas

Pronto! Agora você tem uma compreensão básica do gerenciamento de conteúdo headless no AEM. É claro que há muito mais recursos onde você pode se aprofundar para obter um entendimento abrangente dos recursos disponíveis.

Nesta página