API de GraphQL de AEM para su uso con fragmentos de contenido

Aprenda a utilizar los fragmentos de contenido en Adobe Experience Manager (AEM) as a Cloud Service con la API de GraphQL de AEM para la entrega de contenido sin encabezado.

La API de GraphQL de AEM as a Cloud Service que se utiliza con fragmentos de contenido se basa principalmente en la API estándar de código abierto de GraphQL.

El uso de la API de GraphQL en AEM permite la entrega eficiente de fragmentos de contenido a clientes JavaScript en implementaciones de CMS sin encabezado:

• Evita solicitudes de API iterativas como con REST,
• Garantiza que la entrega se limite a los requisitos específicos,
• Permite la entrega masiva de exactamente lo que se necesita para procesar como respuesta a una sola consulta de API.

La API de GraphQL

GraphQL es:

• “…un idioma de consulta para API y un tiempo de ejecución para cumplir esas consultas con los datos existentes. GraphQL proporciona una descripción completa y comprensible de los datos de su API, ofrece a los clientes la posibilidad de preguntar exactamente lo que necesitan y nada más, facilita la evolución de las API con el paso del tiempo y habilita potentes herramientas para desarrolladores”.

  Consulte GraphQL.org

• “…una especificación abierta para una capa de API flexible. Coloque GraphQL sobre los back-ends existentes para crear productos más rápido que nunca…”.

  Consulte Exploración de GraphQL.

• “…una especificación y lenguaje de consulta de datos desarrollado internamente por Facebook en 2012, antes de pasar a ser de código abierto público en 2015. Proporciona una alternativa a las arquitecturas basadas en REST con el propósito de aumentar la productividad del desarrollador y minimizar las cantidades de datos transferidos. Cientos de organizaciones de todos los tamaños utilizan GraphQL en producción…”

  Consulte Fundamentos de GraphQL.

Para obtener más información acerca de la API de GraphQL, consulte las siguientes secciones (entre muchos otros recursos):

• En graphql.org:

  • Introducción a GraphQL

  • Especificación de GraphQL

• En graphql.com:

  • Guías

  • Tutoriales

  • Casos prácticos

La implementación de GraphQL para AEM se basa en la biblioteca Java estándar de GraphQL. Consulte:

• graphQL.org: Java

• GraphQL Java en GitHub

Terminología de GraphQL

GraphQL utiliza lo siguiente:

• Consultas

• Esquemas y tipos:

  • AEM genera los esquemas basándose en los modelos de fragmentos de contenido.
  • Con sus esquemas, GraphQL presenta los tipos y operaciones permitidos para la implementación de GraphQL para AEM.

• Campos

• Punto de conexión de GraphQL

  • La ruta en AEM que responde a las consultas de GraphQL y proporciona acceso a los esquemas de GraphQL.

  • Consulte Activación del punto de conexión de GraphQL para obtener más información.

Consulte la Introducción a GraphQL (GraphQL.org) para obtener información detallada, incluidas las Prácticas recomendadas.

Tipos de consulta de GraphQL

Con GraphQL puede realizar consultas para devolver lo siguiente:

• Una entrada única

• Una lista de entradas

AEM proporciona funcionalidades para convertir consultas (de ambos tipos) a consultas persistentes, que pueden almacenar en caché Dispatcher y la red de distribución de contenido (CDN).

Prácticas recomendadas para consultas de GraphQL (Dispatcher y CDN)

Las consultas persistentes son el método recomendado para usar en instancias de publicación como estas:

• Se almacenan en caché.
• Se administran centralmente mediante AEM as a Cloud Service.

No se recomiendan las consultas GraphQL que utilizan peticiones POST, ya que no se almacenan en caché, por lo que en una instancia predeterminada, Dispatcher está configurado para bloquear dichas consultas.

Aunque GraphQL también admite peticiones GET, estas pueden alcanzar límites (por ejemplo, la longitud de la dirección URL) que se pueden evitar mediante consultas persistentes.

IDE de GraphiQL

Puede probar y depurar consultas de GraphQL usando el IDE de GraphiQL.

Casos de uso para entornos de creación y publicación

Los casos de uso pueden depender del tipo de entorno de AEM as a Cloud Service:

• Entorno de publicación; se usa para:

  • Datos de consulta para la aplicación JS (caso de uso estándar)

• Entorno de creación; se usa para:

  • Datos de consulta para “fines de administración de contenido”:
    • GraphQL en AEM as a Cloud Service es actualmente una API de solo lectura.
    • La API de REST se puede utilizar para operaciones CR(u)D.

Permisos

Los permisos son los necesarios para acceder a Assets.

Las consultas de GraphQL se ejecutan con el permiso del usuario de AEM de la solicitud subyacente. Si el usuario no tiene acceso de lectura a algunos fragmentos (almacenados como activos), no pasarán a formar parte del conjunto de resultados.

Además, el usuario debe tener acceso a un punto final de GraphQL para poder ejecutar consultas de GraphQL.

Generación de esquemas

GraphQL es una API muy tipificada, lo que significa que los datos deben estar claramente estructurados y organizados por tipo.

La especificación de GraphQL proporciona una serie de directrices sobre cómo crear una API robusta para buscar datos en una instancia determinada. Para ello, un cliente debe recuperar el Esquema, que contiene todos los tipos necesarios para una consulta.

Para los fragmentos de contenido, los esquemas (estructura y tipos) de GraphQL se basan en Modelos de fragmentos de contenido habilitados y sus tipos de datos.

Por ejemplo, si un usuario crea un modelo de fragmento de contenido denominado Article, luego AEM genera un tipo de GraphQL ArticleModel. Los campos dentro de este tipo corresponden a los campos y tipos de datos definidos en el modelo. Además, crea algunos puntos de entrada para las consultas que funcionan en este tipo, como articleByPath o articleList.

1. Un modelo de fragmento de contenido:

   

2. El esquema correspondiente de GraphQL (salida de la documentación automática de GraphiQL):
   

   Esto muestra que el tipo generado ArticleModel contiene varios campos.

   • Tres de ellos han sido controlados por el usuario: author, main y referencearticle.

   • Los otros campos los añadió automáticamente AEM, y representan métodos útiles para proporcionar información acerca de un determinado Fragmento de contenido; en este ejemplo, (los campos de ayuda) _path, _metadata, _variations.

3. Después de que un usuario cree un fragmento de contenido basado en el modelo de artículo, se puede buscar a través de GraphQL. Para ver ejemplos, consulte las Consultas de muestra (basadas en una estructura de fragmentos de contenido de muestra para usar con GraphQL).

En GraphQL para AEM, el esquema es flexible. Esto significa que se genera automáticamente cada vez que se crea, actualiza o elimina un modelo de fragmento de contenido. Las cachés del esquema de datos también se refrescan al actualizar el modelo de fragmento de contenido.

Las cachés del esquema de datos también se refrescan al actualizar el modelo de fragmento de contenido.

El servicio Sites de GraphQL escucha (en segundo plano) cualquier modificación realizada en un modelo de fragmento de contenido. Cuando se detectan actualizaciones, solo se regenera esa parte del esquema. Esta optimización ahorra tiempo y proporciona estabilidad.

Por ejemplo, si:

1. Instala un paquete que contenga Content-Fragment-Model-1 y Content-Fragment-Model-2:

   1. Se generarán tipos de GraphQL para Model-1 y Model-2.

2. A continuación, modifique Content-Fragment-Model-2:

   1. Solo el tipo de GraphQL Model-2 se actualizará.

   2. Mientras que Model-1 seguirá siendo el mismo.

El esquema se sirve a través del mismo punto de conexión que las consultas de GraphQL, y el cliente gestiona el hecho de que se llama al esquema con la extensión GQLschema. Por ejemplo, realizar una solicitud GET simple en /content/cq:graphql/global/endpoint.GQLschema resultará en la salida del esquema con el tipo contenido: text/x-graphql-schema;charset=iso-8859-1.

Generación de esquemas: modelos no publicados

Cuando los fragmentos de contenido están anidados, puede ocurrir que se publique un modelo de fragmento de contenido principal, pero no un modelo al que se hace referencia.

Cuando esto sucede, AEM genera un esquema incompleto del modelo de fragmento del contenido principal. Esto significa que la referencia de fragmento, que depende del modelo no publicado, se elimina del esquema.

Campos

Dentro del esquema hay campos individuales, de dos categorías básicas:

• Campos que genera usted.

  Una selección de Tipos de datos se utiliza para crear campos en función de cómo configure el modelo de fragmentos de contenido. Los nombres de campo se toman del campo Nombre de propiedad de la pestaña Tipo de datos.

  • También hay que tener en cuenta el ajuste Procesar como, ya que los usuarios pueden configurar determinados tipos de datos. Por ejemplo, se puede configurar un campo de texto de una sola línea para que contenga varios textos de una sola línea eligiendo multifield en la lista desplegable.

• GraphQL para AEM también genera una serie de campos de ayuda.

Tipos de datos

GraphQL para AEM admite una lista de tipos. Se representan todos los tipos de datos del modelo de fragmento de contenido compatibles y los tipos de GraphQL correspondientes:

Campos de ayuda

Además de los tipos de datos de los campos generados por el usuario, GraphQL para AEM también genera una serie de campos de ayuda para ayudar a identificar un fragmento de contenido o para proporcionar información adicional acerca de un fragmento de contenido.

Estos campos de ayuda se marcan con un _ que los precede para distinguir entre lo que ha definido el usuario y lo que se ha generado automáticamente.

Ruta

El campo de ruta se utiliza como identificador en AEM GraphQL. Representa la ruta del recurso de fragmento de contenido dentro del repositorio de AEM. Lo hemos elegido como identificador de un fragmento de contenido, por los motivos siguientes:

• es único dentro de AEM,
• se puede recuperar fácilmente.

El siguiente código muestra las rutas de todos los fragmentos de contenido creados en función del modelo de fragmento de contenido Author, tal y como se proporciona en el tutorial de WKND.

{
  authorList {
    items {
      _path
    }
  }
}

Para recuperar un solo fragmento de contenido de un tipo específico, también debe determinar primero su ruta. Por ejemplo:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _path
      firstName
      lastName
    }
  }
}

Consulte Consulta de muestra: un solo fragmento de ciudad específico.

Metadatos

A través de GraphQL, AEM también expone los metadatos de un fragmento de contenido. Los metadatos son la información que describe un fragmento de contenido, como su título, la ruta de la miniatura, la descripción de un fragmento de contenido o la fecha en que se creó, entre otros.

Dado que los metadatos se generan mediante el Editor de esquemas y, como tales, no tienen una estructura específica, el tipo de GraphQL TypedMetaData se ha implementado para exponer los metadatos de un fragmento de contenido. TypedMetaData expone la información agrupada por los siguientes tipos escalares:

Cada tipo escalar representa un único par nombre-valor o una matriz de pares nombre-valor, donde el valor de ese par es del tipo en el que se agrupó.

Por ejemplo, si desea recuperar el título de un fragmento de contenido, sabemos que esta propiedad es de cadena, por lo que consultaremos todos los metadatos de cadena:

Para consultar metadatos:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/sofia-sj-berg") {
    item {
      _metadata {
        stringMetadata {
          name
          value
        }
      }
    }
  }
}

Puede ver todos los tipos de metadatos de GraphQL si ve el esquema de GraphQL generado. Todos los tipos de modelo tienen el mismo TypedMetaData.

Consulte Consulta de muestra para metadatos: enumera los metadatos de los premios titulados GB.

Variaciones

El campo _variations se ha implementado para simplificar la consulta de las variaciones que tiene un fragmento de contenido. Por ejemplo:

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo") {
    item {
      _variations
    }
  }
}

Consulte Consulta de muestra: todas las ciudades con una variación con nombre.

Variables de GraphQL

GraphQL permite colocar variables en la consulta. Para obtener más información, consulte la Documentación de GraphQL para variables.

Por ejemplo, para obtener todos los fragmentos de contenido del tipo Author en una variación específica (si está disponible), puede especificar el argumento variation en GraphiQL.

Consulta:

query($variation: String!) {
  authorList(variation: $variation) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

Variables de consulta:

{
  "variation": "another"
}

Esta consulta devolverá la lista completa de autores. Los autores sin la variación another volverán a los datos originales (_variation informará de master en este caso).

Si desea restringir la lista a autores que proporcionen la variación especificada (y omitir los que vuelvan a los datos originales), deberá aplicar un filtro:

query($variation: String!) {
  authorList(variation: $variation, filter: {
    _variation: {
      _expressions: {
        value: $variation
      }
    }
  }) {
    items {
      _variation
      lastName
      firstName
    }
  }
}

Directivas de GraphQL

En GraphQL existe la posibilidad de cambiar la consulta en función de variables, denominadas Directivas de GraphQL.

Por ejemplo, puede incluir el campo adventurePrice en una consulta para todos los AdventureModels, en función de una variable includePrice.

Consulta:

query GetAdventureByType($includePrice: Boolean!) {
  adventureList {
    items {
      title
      price @include(if: $includePrice)
    }
  }
}

Variables de consulta:

{
    "includePrice": true
}

Filtrado

También puede utilizar el filtrado en las consultas de GraphQL para devolver datos específicos.

El filtrado utiliza una sintaxis basada en operadores lógicos y expresiones.

La parte más atómica es una sola expresión que se puede aplicar al contenido de un campo determinado. Compara el contenido del campo con un valor constante determinado.

Por ejemplo, la expresión

{
  value: "some text"
  _op: EQUALS
}

compararía el contenido del campo con el valor some text y se ejecuta correctamente si es igual al valor. De lo contrario, la expresión fallará.

Los siguientes operadores pueden utilizarse para comparar campos con un determinado valor:

Algunos tipos también permiten especificar opciones adicionales que modifican como se evalúa una expresión:

Las expresiones se pueden combinar en un conjunto con la ayuda de un operador lógico (_logOp):

• OR: el conjunto de expresiones tendrá éxito si al menos una expresión es correcta
• AND: el conjunto de expresiones tendrá éxito si todas las expresiones son correctas (opción predeterminada).

Cada campo se puede filtrar por su propio conjunto de expresiones. Los conjuntos de expresiones de todos los campos mencionados en el argumento de filtro se combinarán finalmente con su propio operador lógico.

Una definición de filtro (que se transfiere como el argumento filter a una consulta) contiene lo siguiente:

• Una subdefinición para cada campo (se puede acceder al campo a través de su nombre, por ejemplo, hay un campo lastName en el filtro para lastName en el Tipo de datos (campo))
• Cada subdefinición contiene la matriz _expressions, que proporciona el conjunto de expresiones, y el campo _logOp que define el operador lógico con el que deben combinarse las expresiones
• Cada expresión está definida por el valor (campo value) y el operador (campo _operator), el contenido de un campo debe compararse con

Tenga en cuenta que puede omitir _logOp si desea combinar elementos con AND y _operator si pretende comprobar la igualdad, ya que estos son los valores predeterminados.

El siguiente ejemplo muestra una consulta completa que filtra todas las personas que tienen un lastName de Provo o con sjö, independientemente del caso:

{
  authorList(filter: {
    lastname: {
      _logOp: OR
      _expressions: [
        {
          value: "sjö",
          _operator: CONTAINS,
          _ignoreCase: true
        },
        {
          value: "Provo"
        }
      ]
    }
  }) {
    items {
      lastName
      firstName
    }
  }
}

Aunque también puede filtrar por campos anidados, no se recomienda, ya que puede provocar problemas de rendimiento.

Para ver más ejemplos, consulte lo siguiente:

• detalles de GraphQL para extensiones de AEM

• Ejemplos de consultas que utilizan este contenido y estructura de muestra

  • Y el Contenido y estructura de muestra preparados para su uso en consultas de muestra

• Consultas de muestra basadas en el proyecto WKND

Ordenación

Esta función permite ordenar los resultados de la consulta según un campo especificado.

Los criterios de clasificación son los siguientes:

• una lista de valores separados por comas que representa la ruta del campo
  • el primer campo de la lista define el criterio de clasificación principal, el segundo se utiliza si dos valores del criterio de clasificación principal son iguales, el tercero si los dos primeros criterios son iguales, etc.
  • notación con puntos, es decir campo1.subcampo.subcampo, etc.
• una dirección de orden opcional
  • ASC (de subida) o DESC (de bajada); ASC se aplica como predeterminado
  • se puede especificar la dirección por campo; esto significa que puede ordenar un campo en orden de subida y otro en orden de bajada (nombre, apellido DESC)

Por ejemplo:

query {
  authorList(sort: "lastName, firstName") {
    items {
      firstName
      lastName
    }
  }
}

Y también:

{
  authorList(sort: "lastName DESC, firstName DESC") {
    items {
        lastName
        firstName
    }
  }
}

También puede ordenar un campo dentro de un fragmento anidado, utilizando el formato de nestedFragmentname.fieldname.

Por ejemplo:

query {
  articleList(sort: "authorFragment.lastName")  {
    items {
      title
      authorFragment {
        firstName
        lastName
        birthDay
      }
      slug
    }
  }
}

Paginación

Esta funcionalidad le permite paginar en tipos de consulta que devuelven una lista. Se proporcionan dos métodos:

• offset y limit en una consulta List
• first y after en una consulta Paginated

Consulta de lista: desplazamiento y límite

En una consulta ...List puede utilizar offset y limit para devolver un subconjunto específico de resultados:

• offset: especifica el primer conjunto de datos que se va a devolver
• limit: especifica el número máximo de conjuntos de datos que se van a devolver

Por ejemplo, para generar la página de resultados que contiene hasta cinco artículos, a partir del quinto artículo de la lista de resultados completa:

query {
   articleList(offset: 5, limit: 5) {
    items {
      authorFragment {
        lastName
        firstName
      }
    }
  }
}

Consulta paginada: primero y después

El tipo de consulta ...Paginated reutiliza la mayoría de las funciones de tipo de consulta ...List (filtrado, clasificación), pero en lugar de usar argumentos offset/limit, emplea los argumentos first/after definidos por la especificación de las conexiones del cursor de GraphQL. Puede encontrar una introducción menos formal en la Introducción a GraphQL.

• first: los primeros n artículos que se van a devolver.
  El valor predeterminado es 50.
  El número máximo es 100.
• after: el cursor que determina el comienzo de la página solicitada; tenga en cuenta que el elemento representado por el cursor no se incluye en el conjunto de resultados; el cursor de un elemento se determina mediante el campo cursor de la estructura edges.

Por ejemplo, mostrar la página de resultados que contiene hasta cinco aventuras, empezando por el elemento de cursor dado en la lista de resultados completa:

query {
    adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
        edges {
          cursor
          node {
            title
          }
        }
        pageInfo {
          endCursor
          hasNextPage
        }
    }
}

GraphQL para AEM: resumen de extensiones

El funcionamiento básico de las consultas con GraphQL para AEM se adhiere a la especificación estándar de GraphQL. Para las consultas de GraphQL con AEM hay algunas extensiones:

• Si espera una lista de resultados:

  • añada List al nombre del modelo; por ejemplo, cityList
  • Consulte Consulta de muestra: toda la información acerca de todas las ciudades

  Podrá hacer lo siguiente:

  • Clasificación de los resultados

    • ASC: ascendente
    • DESC: descendente

  • Devuelva una página de resultados utilizando lo siguiente:

    • Una consulta de lista con desplazamiento y límite
    • Una consulta paginada con primero y después

  • Consulte Consulta de muestra: toda la información acerca de todas las ciudades

• Si necesita un solo resultado:

  • utilice el nombre del modelo; p. ej., ciudad

• Si espera una lista de resultados:

  • añada List al nombre del modelo; por ejemplo, cityList
  • Consulte Consulta de muestra: toda la información acerca de todas las ciudades

• Si desea utilizar un OR lógico:

  • use _logOp: OR
  • Consulte Consulta de muestra: todas las personas que tienen el apellido “Jobs” o “Smith”

• El AND lógico también existe, pero (a menudo) está implícito

• Puede consultar los nombres de campo que se correspondan con los campos del modelo de fragmento de contenido

  • Consulte Consulta de muestra: detalles completos del CEO y los empleados de una compañía

• Además de los campos del modelo, hay algunos campos generados por el sistema (precedidos de guiones bajos):

  • Para el contenido:

    • _locale: para revelar el idioma; basado en el Administrador de idiomas

      • Consulte Consulta de muestra para varios fragmentos de contenido de una configuración regional determinada

    • _metadata: para mostrar los metadatos del fragmento

      • Consulte Consulta de muestra para metadatos: enumera los metadatos de los premios titulados GB

    • _model: permitir la consulta de un modelo de fragmento de contenido (ruta y título)

      • Consulte Consulta de muestra para un modelo de fragmento de contenido de un modelo

    • _path: la ruta al fragmento de contenido dentro del repositorio

      • Consulte Consulta de muestra: un solo fragmento de ciudad específico

    • _reference: para revelar referencias, incluyendo referencias en línea en el Editor de texto enriquecido

      • Consulte Consulta de muestra para varios fragmentos de contenido con referencias recuperadas previamente

    • _variation: para mostrar variaciones específicas dentro del fragmento de contenido

      NOTA

      Si la variación dada no existe para un Fragmento de contenido, la variación principal se devolverá como una predeterminada (alternativa).

      • Consulte Consulta de muestra: todas las ciudades con una variación con nombre

  • Y operaciones:

    • _operator: aplicar operadores específicos; EQUALS, EQUALS_NOT, GREATER_EQUAL, LOWER, CONTAINS, STARTS_WITH
      • Consulte Consulta de muestra: todas las personas que no tienen el apellido “Jobs”
      • Consulte Consulta de muestra: todas las aventuras en las que la _path comienza con un prefijo específico
    • _apply: para aplicar condiciones específicas; por ejemplo, AT_LEAST_ONCE
      • Consulte Consulta de muestra: filtre en una matriz con un elemento que deba producirse al menos una vez
    • _ignoreCase: para ignorar el caso al consultar
      • Consulte Consulta de muestra: todas las ciudades con SAN en el nombre, sin importar las mayúsculas

• Se admiten los tipos de unión de GraphQL:

  • use ... on
    • Consulte Consulta de muestra para un fragmento de contenido de un modelo específico con una referencia de contenido

• Alternativa cuando se consultan fragmentos anidados:

  • Si una variación determinada no existe en un fragmento anidado, se devolvería la variación Principal.

Consulta del punto de conexión de GraphQL desde un sitio web externo

Para acceder al punto de conexión de GraphQL desde un sitio web externo, debe configurar lo siguiente:

• Filtro CORS
• Filtro de referente

Autenticación

Consulte Autenticación para consultas de GraphQL de AEM remotas en fragmentos de contenido.

Preguntas frecuentes

Preguntas que han surgido:

1. P: “¿En qué se diferencia la API de GraphQL para AEM de la API Generador de consultas?”

   • R: “La API de GraphQL de AEM ofrece control total sobre la salida JSON y es un estándar en la industria para consultar contenido.
     En adelante, AEM tiene previsto invertir en la API de GraphQL de AEM”.

Tutorial: Introducción a AEM Headless y GraphQL

¿Busca un tutorial práctico? Consulte el tutorial completo Introducción a AEM Headless y GraphQL, que ilustra cómo crear y exponer contenido mediante las API de GraphQL de AEM y consumido por una aplicación externa, en un escenario de CMS sin encabezado.

Recursos de Business.Adobe.com