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.

NOTA

Algunas de sus funcionalidades están disponibles en el canal de prelanzamiento. En concreto, la funcionalidad relacionada con las consultas persistentes.

Consulte la Documentación del canal de prelanzamiento para obtener información sobre cómo habilitar la función para su entorno.

¿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.

El resto de esta guía se centrará 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. El diálogo Crear nuevo punto de conexión de GraphQL se abrirá. Aquí puede especificar lo siguiente:

    • Nombre: nombre del punto de conexión; puede escribir cualquier texto.
    • Utilice el esquema 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 es la ruta utilizada 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 deberán diseñar consultas para sus puntos de conexión de canal para poder entregar contenido. Por lo general, estas consultas solo tendrán que considerarse una vez por punto de conexión y modelo. Para los fines de esta guía de introducción solo tendremos que crear una.

GraphiQL es un IDE que se puede instalar en un entorno de AEM. Siga los pasos de Uso del IDE de GraphiQL para instalarlo en su entorno de AEM.

  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 su 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.

    Editor de GraphiQL

  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.
    Consulta de GraphiQL

  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.
    Resultados de GraphiQL

  6. Haga clic en el vínculo Documentos en la parte superior derecha de la página para mostrar la documentación en contexto que le ayudará a crear sus consultas, que se adaptan a sus propios modelos.
    Documentación de GraphiQL

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, así como 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. Por supuesto, hay muchos más recursos en los que puede profundizar para comprender las funciones disponibles.

En esta página