Gerenciar endpoints de GraphQL no AEM graphql-aem-endpoint
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.
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 enabling-graphql-endpoint
Para habilitar um endpoint de GraphQL, primeiro é necessário ter uma configuração apropriada. Consulte Fragmentos de conteúdo - Navegador de configuração.
Para habilitar o endpoint correspondente:
-
Navegue até Ferramentas, Geral e, em seguida, selecione GraphQL.
-
Selecione Criar.
-
A caixa de diálogo Criar novo Ponto de Extremidade do GraphQL é 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 o site/projeto necessário.
note note NOTE O seguinte aviso é mostrado na caixa de diálogo: - Os endpoints do GraphQL podem apresentar problemas de desempenho e de segurança de dados se não forem gerenciados com cuidado. Certifique-se de que as permissões apropriadas estejam definidas após a criação de um ponto de acesso.
-
Confirme com Criar.
-
A caixa de diálogo Próximas etapas fornecerá um link direto para o console de Segurança, para que você possa garantir que o ponto de extremidade criado tenha as permissões adequadas.
note caution CAUTION 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 publishing-graphql-endpoint
Selecione o novo endpoint e escolha Publicar para disponibilizá-lo completamente, em todos os ambientes.