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 se puede quitar.
Debe tener configurados los puntos de conexión en el explorador de configuración antes de utilizar el IDE de GraphiQL.
La herramienta GraphiQL 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 solicitudes de GET y para publicar consultas. Para el uso de producción, puede mueva 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 mostrará 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 mostrará en el panel Editor.
En cualquier caso, la consulta que se muestra en el panel Editor es la que se ejecutará cuando:
Control-Enter
El IDE de GraphiQL también le permite administrar sus variables de consulta.
Por ejemplo:
Una vez seleccionada la consulta persistente en la lista (panel izquierdo), puede utilizar las acciones Publicación y Cancelar la publicación. Esto los activará en el entorno de publicación (por ejemplo, dev-publish
) para facilitar el acceso de las aplicaciones durante las 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).
AEM invalidará la caché de la red de distribución de contenido (CDN) en función de un tiempo de vida predeterminado (TTL).
Este valor se establece en lo siguiente:
Las consultas de GraphQL de AEM que persistieron con la IU de GraphiQL utilizarán el TTL predeterminado al ejecutarse. Si desea cambiar el TTL para la consulta de GraphLQ, la consulta debe persistir usando el método de API. Esto implica publicar la consulta en AEM usando CURL en la interfaz de línea de comandos.
Por ejemplo:
curl -X PUT \
-H 'authorization: Basic YWRtaW46YWRtaW4=' \
-H "Content-Type: application/json" \
"http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
-d \
'{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
El cache-control
se puede configurar en el momento de la creación (PUT) o más tarde (por ejemplo, mediante una petición POST). El control de caché es opcional al crear la consulta persistente, ya que AEM puede proporcionar el valor predeterminado. Consulte Conservación de una consulta de GraphQL para ver un ejemplo de persistencia de una consulta utilizando curl.
La opción Copiar URL 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
.