Creación de una solicitud de API: configuración sin encabezado

Aprenda a utilizar la API de GraphQL para la entrega sin encabezado de contenido de fragmentos de contenido y la API de REST de Assets de AEM para administrar fragmentos de contenido.

¿Qué son las API de REST de GraphQL y Assets?

Ahora que ha creado algunos fragmentos de contenido, puede utilizar las API de AEM para entregarlas sin problemas.

• La API de GraphQL permite crear solicitudes para acceder a fragmentos de contenido y enviarlos. Esta API ofrece el conjunto más sólido de funciones para consultar y consumir contenido de fragmentos de contenido.
  • Para utilizar la API, defina y habilite puntos finales en AEM y, si es necesario, la interfaz de GraphiQL instalada.
• La API de REST de Assets permite crear y modificar fragmentos de contenido (y otros recursos).

El resto de esta guía se centra en el acceso a GraphQL y la entrega de fragmentos de contenido.

Habilitación del punto de conexión de GraphQL

Antes de poder utilizar las API de GraphQL, se debe crear un punto de conexión de GraphQL.

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

2. Seleccione Crear.

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

   • Nombre: nombre del punto de conexión; puede escribir cualquier texto.
   • Usar esquema de GraphQL proporcionado por: utilice la lista desplegable para seleccionar la configuración requerida.

4. Confirme con Crear.

5. En la consola, ahora se muestra una Ruta en función de la configuración creada anteriormente. Esta ruta se utiliza para ejecutar consultas de GraphQL.

   /content/cq:graphql/<configuration-name>/endpoint
   

Se pueden encontrar más detalles acerca de la activación de los puntos de conexión de GraphQL aquí.

Consulta de contenido mediante GraphQL con GraphiQL

Los arquitectos de la información diseñan consultas para sus puntos finales de canal para entregar contenido. Considere estas consultas solo una vez por punto final, por modelo. Para los fines de esta guía de introducción, solo debe crear uno.

GraphiQL es un IDE, incluido en su entorno AEM; es accesible/visible después de configurar los extremos.

1. Inicie sesión en AEM as a Cloud Service y acceda a la interfaz de GraphiQL:

   Puede acceder al editor de consultas desde:

   • Herramientas -> General -> Editor de consultas de GraphQL
   • directamente; por ejemplo, http://localhost:4502/aem/graphiql.html

2. El IDE de GraphiQL es un editor de consultas en el explorador para GraphQL. Puede utilizarlo para generar consultas, recuperar fragmentos de contenido y entregarlos sin encabezado como JSON.

   • La parte superior derecha desplegable le permite seleccionar el punto de conexión.
   • Un panel del extremo izquierdo enumera las consultas persistentes (cuando están disponibles)
   • El panel intermedio de la izquierda le permite generar la consulta.
   • El panel intermedio de la derecha muestra los resultados.
   • El editor de consultas incluye la finalización del código y teclas de función para ejecutar fácilmente la consulta.

   

3. Suponiendo que el modelo que hemos creado se llamara person con campos firstName, lastName y position, podemos generar una consulta sencilla para recuperar el contenido de nuestro fragmento de contenido.

   query
   {
     personList {
       items {
         _path
         firstName
         lastName
         position
       }
     }
   }
   

4. Introduzca la consulta en el panel izquierdo.
   

5. Haga clic en el botón Ejecutar consulta o use la tecla de función Ctrl-Enter, los resultados se mostrarán como JSON en el panel derecho.
   

6. En la esquina superior derecha de la página, haga clic en Documentos para mostrar la documentación en contexto y poder crear consultas que se adapten a sus propios modelos.
   

GraphQL permite consultas estructuradas que pueden dirigirse no solo a conjuntos de datos específicos u objetos de datos individuales, sino que también pueden proporcionar elementos específicos de los objetos, resultados anidados, compatibilidad con variables de consulta y mucho más.

GraphQL puede evitar las solicitudes de API iterativas y el exceso de entrega, y en su lugar permite realizar entregas masivas de exactamente lo que se necesita para procesar como respuesta a una única consulta de API. El JSON resultante se puede utilizar para entregar datos en otros sitios o aplicaciones.

Siguientes pasos

¡Eso es todo! Ahora tiene una comprensión básica de la administración de contenido sin encabezado en AEM. Hay muchos más recursos en los que puede profundizar para comprender las funciones disponibles.

• Fragmentos de contenido: para obtener más información acerca de la creación y administración de fragmentos de contenido
• Compatibilidad con fragmentos de contenido en la API HTTP de AEM Assets: para obtener más información sobre el acceso al contenido de AEM directamente a través de la API HTTP, mediante las operaciones CRUD (Crear, Leer, Actualizar, Eliminar)
• API de GraphQL: para obtener más información sobre cómo enviar fragmentos de contenido sin encabezado