Criar uma solicitação de API - Configuração Headless accessing-delivering-content-fragments

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.

O que são as APIs REST do GraphQL e do Assets? what-are-the-apis

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

NOTE
A variável OpenAPIs de fragmento de conteúdo e modelo de fragmento de conteúdo também estão disponíveis.

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

Habilitar endpoint GraphQL enable-graphql-endpoint

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

  1. Navegue até Ferramentas, Geral e, em seguida, selecione GraphQL.

  2. Selecione Criar.

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

    • Nome: nome do endpoint; é possível inserir qualquer texto.
    • Usar esquema do 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 caminho é usado para executar consultas do GraphQL.

    code language-none
    /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 projetam consultas para seus pontos de acesso de canal para fornecer conteúdo. Considere essas consultas apenas uma vez por ponto de acesso, por modelo. Para os propósitos deste guia de introdução, só é necessário criar um.

GraphiQL é um IDE, incluído no seu ambiente do AEM; ele se torna acessível/visível após configurar seus pontos de acesso.

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

    É possível 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.

    • O menu suspenso 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 criado 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.

    code language-text
    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. No canto superior direito da página, clique no link Documentos para mostrar a documentação contextual para que você possa criar suas consultas que se adaptem 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 e entrega em excesso e, em vez disso, permite a entrega em massa exatamente do que é necessário para renderizar em resposta a uma única consulta de API. O JSON resultante pode ser usado para fornecer dados a outros sites ou aplicativos.

Próximas etapas next-steps

Pronto! Agora você tem uma compreensão básica do gerenciamento de conteúdo headless no AEM. Existem muitos outros recursos onde é possível se aprofundar para obter um entendimento abrangente dos recursos disponíveis.

NOTE
A variável OpenAPIs de fragmento de conteúdo e modelo de fragmento de conteúdo também estão disponíveis.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab