Administración de puntos de conexión de GraphQL en AEM graphql-aem-endpoint

El punto de conexión es la ruta utilizada para acceder a GraphQL para AEM. Al utilizar esta ruta, usted (o su aplicación) puede hacer lo siguiente:

  • acceder al esquema de GraphQL,
  • enviar sus consultas de GraphQL,
  • recibir las respuestas (a sus consultas de GraphQL).

Hay dos tipos de puntos de conexión en AEM:

  • Globales

    • Disponibles para su uso en todos los sitios.
    • Este punto de conexión puede utilizar todos los modelos de fragmento de contenido de todas las configuraciones de sitios (definidas en el Explorador de configuración).
    • Si hay algún modelo de fragmento de contenido que debería compartirse entre las configuraciones de Sites, estos deberían crearse en las configuraciones globales de Sites.
  • Configuraciones de Sites:

    • Corresponde a una configuración de Sites, tal como se define en el Explorador de configuración.
    • Específico de un sitio o proyecto concreto.
    • Un punto de conexión específico de la configuración de Sites usará los modelos de fragmento de contenido de esa configuración de Sites específica junto con los de la configuración de Sites global.
CAUTION
El editor de fragmentos de contenido puede permitir que un fragmento de contenido de una configuración de Sites haga referencia a un fragmento de contenido de otra configuración de Sites (a través de políticas).
En tal caso, no todo el contenido se podrá recuperar mediante un punto final específico de configuración de Sites.
El autor del contenido debe controlar este escenario; por ejemplo, puede resultar útil considerar la posibilidad de colocar los modelos de fragmento de contenido compartido en la configuración de Sites global.

La ruta del repositorio del punto de conexión global de GraphQL para AEM es la siguiente:

/content/cq:graphql/global/endpoint

Para lo cual su aplicación puede utilizar la siguiente ruta en la dirección URL de la solicitud:

/content/_cq_graphql/global/endpoint.json

Para habilitar un punto de conexión para GraphQL para AEM, debe hacer lo siguiente:

Activación del punto de conexión de GraphQL enabling-graphql-endpoint

Para habilitar un punto de conexión de GraphQL, primero debe tener una configuración adecuada. Consulte Fragmentos de contenido: explorador de configuración.

CAUTION
Si no se ha habilitado el uso de modelos de fragmentos de contenido, la opción Crear no estará disponible.

Para habilitar el punto de conexión correspondiente:

  1. Vaya a Herramientas, General y, a continuación, seleccione GraphQL.

  2. Seleccione Crear.

  3. Se abre el cuadro de diálogo Crear nuevo extremo de GraphQL. Aquí puede especificar lo siguiente:

    • Nombre: nombre del punto de conexión; puede escribir cualquier texto.
    • Usar esquema de GraphQL proporcionado por: use la lista desplegable para seleccionar el sitio o proyecto requerido.
    note note
    NOTE
    La siguiente advertencia se muestra en el cuadro de diálogo:
    • Los puntos finales de GraphQL pueden introducir problemas de rendimiento y seguridad de datos si no se administran con cuidado. Asegúrese de que se han establecido los permisos adecuados después de crear un punto final.
  4. Confirme con Crear.

  5. El cuadro de diálogo Pasos siguientes proporcionará un vínculo directo a la consola de seguridad para que pueda asegurarse de que el extremo creado tenga los permisos adecuados.

    note caution
    CAUTION
    El punto de conexión es accesible para todos. Esto puede suponer un problema de seguridad, especialmente en las instancias de publicación, ya que las consultas de GraphQL pueden imponer una carga pesada en el servidor.
    Puede configurar ACL, según su caso de uso, en el punto de conexión.

Publicación del punto de conexión de GraphQL publishing-graphql-endpoint

Seleccione el nuevo punto de conexión y Publicación para que esté totalmente disponible en todos los entornos.

CAUTION
El punto de conexión es accesible para todos.
En instancias de publicación esto puede suponer un problema de seguridad, ya que las consultas de GraphQL pueden imponer una carga pesada en el servidor.
Configure ACL apropiados para su caso de uso en el punto de conexión.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab