Gerenciar endpoints de GraphQL no AEM

O endpoint é o caminho usado para acessar o GraphQL no AEM. Usando esse caminho, você (ou seu aplicativo) pode:

  • acessar o esquema de GraphQL,
  • enviar suas consultas de GraphQL,
  • receber as respostas (para suas consultas de GraphQL).

Há dois tipos de endpoints no AEM:

  • Global
    • Disponível para uso por todos os sites.
    • Esse endpoint pode usar todos os modelos de fragmento de conteúdo de todas as configurações do Sites (definidas no Navegador de configuração).
    • Se houver modelos de fragmento de conteúdo que devem ser compartilhados entre as configurações do Sites, eles devem ser criados nas configurações globais do Sites.
  • Configurações do Sites:
    • Corresponde a uma configuração do Sites, conforme definido no Navegador de configuração.
    • Específico de um site/projeto especificado.
    • Um endpoint específico de uma configuração do Sites usará os modelos de fragmento de conteúdo dessa configuração, junto com aqueles da configuração global do Sites.
ATENÇÃO

O Editor de fragmento de conteúdo pode permitir que um fragmento de conteúdo de uma configuração do Sites faça referência a um fragmento de conteúdo de outra configuração do Sites (por meio de políticas).

Nesse caso, nem todo o conteúdo poderá ser recuperado usando um endpoint específico de uma configuração do Sites.

O autor de conteúdo deve controlar esse cenário; por exemplo, pode ser útil considerar colocar modelos de fragmento de conteúdo compartilhados na configuração global do Sites.

O caminho do repositório do GraphQL para o endpoint global do AEM é:

/content/cq:graphql/global/endpoint

Para o qual seu aplicativo pode usar o seguinte caminho no URL da solicitação:

/content/_cq_graphql/global/endpoint.json

Para habilitar um endpoint para GraphQL no AEM, é necessário:

Habilitação do seu endpoint de GraphQL

Para habilitar um endpoint de GraphQL, primeiro é necessário ter uma configuração apropriada. Consulte Fragmentos de conteúdo - Navegador de configuração.

ATENÇÃO

Se o uso de modelos de fragmento de conteúdo não foi habilitado, a opção Criar não estará disponível.

Para habilitar o endpoint correspondente:

  1. Navegue até Ferramentas, Ativos e, 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 o esquema de GraphQL fornecido por: use a lista suspensa para selecionar o site/projeto necessário.
    OBSERVAÇÃO

    O seguinte aviso é mostrado na caixa de diálogo:

    • Os endpoints de GraphQL podem causar problemas de segurança e desempenho de dados se não forem gerenciados com cuidado. Defina as permissões apropriadas após criar um endpoint.

  4. Confirme com Criar.

  5. A caixa de diálogo Próximas etapas fornecerá um link direto até o console de Segurança, para que você possa garantir que o endpoint recém-criado tenha as permissões adequadas.

    ATENÇÃO

    O endpoint é acessível a todos. Isso pode causar uma preocupação de segurança, especialmente em instâncias de publicação, já que as consultas de GraphQL podem colocar uma carga pesada sobre o servidor.

    É possível configurar ACLs apropriadas ao seu caso de uso no endpoint.

Publicar seu endpoint de GraphQL

Selecione o novo endpoint e escolha Publicar para disponibilizá-lo completamente, em todos os ambientes.

ATENÇÃO

O endpoint é acessível a todos.

Isso pode causar uma preocupação de segurança em instâncias de publicação, já que as consultas de GraphQL podem colocar uma carga pesada sobre o servidor.

Você deve configurar ACLs apropriadas ao seu caso de uso no endpoint.

Nesta página