Hay una implementación del IDE de GraphiQL disponible para su uso con la API de GraphQL de Adobe Experience Manager (AEM) as a Cloud Service.
GraphiQL se incluye en todos los entornos de AEM (pero solo será accesible/visible al configurar los extremos).
En versiones anteriores, se necesitaba un paquete para instalar el IDE de GraphiQL. Si tiene esto instalado, ahora lo puede quitar.
Debe tener configurados los puntos de conexión en el explorador de configuración antes de utilizar el IDE de GraphiQL.
El GraphiQL Esta herramienta permite probar y depurar las consultas de GraphQL permitiéndole lo siguiente:
dev-publish
Puede acceder al editor de consultas desde:
http://localhost:4502/aem/graphiql.html
Puede utilizar GraphiQL en el sistema para que la aplicación cliente pueda solicitar consultas mediante peticiones GET y consultas de publicación. Para el uso en producción, debe mover las consultas al entorno de producción. Inicialmente, al creador de producción para validar contenido recién creado con las consultas y, después, para publicar la producción para consumo activo.
Como primer paso, debe seleccionar el Punto de conexión que desea utilizar para las consultas. El punto de conexión es apropiado para la configuración de sitios que desea usar para sus consultas.
Esta opción está disponible en la lista desplegable de la parte superior derecha.
Puede introducir la nueva consulta en el editor, que se encuentra en el panel central izquierdo, directamente debajo del logotipo de GraphiQL.
Si ya ha seleccionado una consulta persistente y se muestra en el panel del editor, seleccione +
(junto a Consultas persistentes) para vaciar el editor listo para la nueva consulta.
Empiece a escribir, el editor también hace lo siguiente:
Las consultas de GraphQL suelen comenzar con un carácter {
.
Las líneas que comienzan con #
se ignoran.
Use Guardar como para que persista la nueva consulta.
Seleccione la consulta que desee actualizar en la lista del panel Consultas persistentes (extremo izquierdo).
La consulta se muestra en el panel del editor. Realice los cambios que necesite y, a continuación, utilice Guardar para confirmar las actualizaciones en la consulta persistente.
Puede ejecutar una nueva consulta inmediatamente, o bien puede cargar y ejecutar una consulta persistente. Para cargar una consulta persistente, selecciónela en la lista; se muestra en el panel Editor.
En cualquier caso, la consulta que se muestra en el panel Editor es la que se ejecuta cuando ocurre lo siguiente:
Control-Enter
El IDE de GraphiQL también le permite administrar sus Variables de consulta.
Por ejemplo:
Se recomiendan las Consultas persistentes, ya que se pueden almacenar en caché en las capas de Dispatcher y CDN, mejorando finalmente el rendimiento de la aplicación cliente solicitante. De forma predeterminada, AEM invalidará la caché de la red de distribución de contenido (CDN) en función de un tiempo de vida predeterminado (TTL).
Las reglas de reescritura personalizadas en Dispatcher pueden anular los valores predeterminados de publicación de AEM.
En el caso de que esté enviando encabezados de control de caché basados en TTL desde Dispatcher, según un patrón de coincidencia de ubicación, si es necesario, es posible que desee excluir /graphql/execute.json/*
de los partidos.
Con GraphQL puede configurar los encabezados de caché HTTP para controlar estos parámetros para la consulta persistente individual.
La opción Encabezados es accesible a través de los tres puntos verticales a la derecha del nombre de la consulta persistente (panel de la izquierda):
Al seleccionar esta opción, se abre Configuración de caché Cuadro de diálogo:
Seleccione el parámetro adecuado y, a continuación, ajuste el valor según sea necesario:
Seleccione Guardar para mantener los cambios.
Una vez seleccionada la consulta persistente de la lista (panel izquierdo), puede utilizar la acción de Publicación.
Esto activará la consulta en el entorno que seleccione. Puede elegir tanto su entorno de Publish (por ejemplo, dev-publish
), o su entorno de Vista previa para facilitar el acceso a las aplicaciones a la hora de realizar pruebas.
La definición de la caché de la consulta persistente Time To Live
{"cache-control":"parameter":value} tiene un valor predeterminado de dos horas (7200 segundos).
Al igual que al publicar, una vez seleccionada la consulta persistente en la lista (panel izquierdo), puede utilizar la acción de Cancelar publicación.
Esto desactivará la consulta del entorno que seleccione; o bien su entorno Publish, o su bien su entorno Vista previa.
También debe asegurarse de haber realizado los cambios necesarios en la aplicación del cliente para evitar posibles problemas.
El Copiar URL Esta opción permite simular una consulta copiando la URL utilizada para acceder directamente a la consulta persistente y ver los resultados. Esto se puede utilizar para hacer pruebas; por ejemplo, accediendo en un explorador:
Por ejemplo:
http://localhost:4502/graphql/execute.json/global/article-list-01
Con esta dirección URL en un explorador, puede confirmar los resultados:
La opción Copiar URL es accesible a través de los tres puntos verticales a la derecha del nombre de la consulta persistente (panel de la izquierda):
La opción Eliminar también es accesible a través de los tres puntos verticales a la derecha del nombre de la consulta persistente (panel de la izquierda).
Después de desarrollar y probar la consulta persistente con GraphiQL, el objetivo final es transferirlo a su entorno de producción para que lo usen sus aplicaciones.
Hay una selección de métodos abreviados de teclado que proporcionan acceso directo a los iconos de acción en el IDE:
Shift-Control-P
Shift-Control-M
Control-Enter
Control-Space
En algunos teclados, la tecla Control
está etiquetada como Ctrl
.