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:
GraphQL se utiliza actualmente en dos escenarios (independientes) en Adobe Experience Manager (AEM) as a Cloud Service:
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 información acerca de la API de GraphQL, consulte las siguientes secciones (entre muchos otros recursos):
En graphql.org:
En graphql.com:
La implementación de GraphQL para AEM se basa en la biblioteca Java estándar de GraphQL. Consulte:
GraphQL utiliza lo siguiente:
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.
Con GraphQL puede realizar consultas para devolver lo siguiente:
Una entrada única
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).
Las consultas persistentes son el método recomendado para usar en instancias de publicación como estas:
Normalmente, no hay ningún Dispatcher/red de distribución de contenido (CDN) en creación, por lo que no hay beneficio en usar consultas persistentes allí, excepto para probarlas.
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.
Consulte Habilitar el almacenamiento en caché de consultas persistentes para obtener más información.
Para permitir consultas directas o POST en Dispatcher, puede pedir al administrador del sistema que realice lo siguiente:
ENABLE_GRAPHQL_ENDPOINT
.true
La capacidad de realizar consultas directas puede quedar obsoleta en algún momento futuro.
Puede probar y depurar consultas de GraphQL usando el IDE de GraphiQL.
Los casos de uso pueden depender del tipo de entorno de AEM as a Cloud Service:
Entorno de publicación; se usa para:
Entorno de previsualización; se usa para:
Entorno de creación; se usa para:
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.
GraphQL es una API con establecimiento inflexible de tipos, 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.
Todos los esquemas de GraphQL (derivados de los modelos de fragmentos de contenido que se han habilitado) se pueden leer a través del punto de conexión de GraphQL.
Esto significa que debe asegurarse de que no hay datos confidenciales disponibles, ya que podrían filtrarse de esta manera; por ejemplo, esto incluye información que podría estar presente como nombres de campo en la definición del modelo.
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
.
Un modelo de fragmento de contenido:
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
.
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:
Instala un paquete que contenga Content-Fragment-Model-1
y Content-Fragment-Model-2
:
Model-1
y Model-2
.A continuación, modifique Content-Fragment-Model-2
:
Solo el tipo de GraphQL Model-2
se actualizará.
Mientras que Model-1
seguirá siendo el mismo.
Esto es importante tenerlo en cuenta en caso de que desee realizar actualizaciones masivas en los modelos de fragmento de contenido a través de la API de REST o de otro modo.
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
.
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.
La IU de AEM evita que esto ocurra, pero si la publicación se realiza mediante programación o con paquetes de contenido, puede ocurrir.
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.
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.
multifield
en la lista desplegable.GraphQL para AEM también genera una serie de campos de ayuda.
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:
Modelo de fragmento de contenido: tipo de datos | Tipo de GraphQL | Descripción |
---|---|---|
Texto de línea única | String , [String] |
Se utiliza para cadenas simples como nombres de autor, nombres de ubicación, etc. |
Texto multilínea | String , [String] |
Se utiliza para generar texto como el cuerpo de un artículo |
Número | Float , [Float] |
Se utiliza para mostrar números de coma flotante y números regulares |
Booleano | Boolean |
Se utiliza para mostrar casillas de verificación → instrucciones simples verdaderas/falsas |
Fecha y hora | Calendar |
Se utiliza para mostrar la fecha y la hora en formato ISO 8601. Según el tipo seleccionado, hay tres variantes disponibles para usar en AEM GraphQL: onlyDate , onlyTime , dateTime |
Lista desglosada | String |
Se utiliza para mostrar una opción de una lista de opciones definidas en la creación del modelo |
Etiquetas | [String] |
Se utiliza para mostrar una lista de cadenas que representan las etiquetas utilizadas en AEM |
Referencia de contenido | String , [String] |
Se utiliza para mostrar la ruta hacia otro recurso en AEM |
Referencia al fragmento | Un tipo de modelo Campo único: Model - Tipo de modelo al que se hace referencia directamente Multicampo, con un tipo al que se hace referencia: [Model] matriz de tipo Model , referenciado directamente desde la matriz Multicampo, con varios tipos de referencia: [AllFragmentModels] : matriz de todos los tipos de modelo, referenciada desde matriz con tipo de unión |
Se utiliza para hacer referencia a uno o más fragmentos de contenido de ciertos tipos de modelo, definidos cuando se creó el modelo |
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 identificar un fragmento de contenido o proporcionar información adicional acerca de este.
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.
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:
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.
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:
Campo |
---|
stringMetadata:[StringMetadata]! |
stringArrayMetadata:[StringArrayMetadata]! |
intMetadata:[IntMetadata]! |
intArrayMetadata:[IntArrayMetadata]! |
floatMetadata:[FloatMetadata]! |
floatArrayMetadata:[FloatArrayMetadata]! |
booleanMetadata:[BooleanMetadata]! |
booleanArrayMetadata:[booleanArrayMetadata]! |
calendarMetadata:[CalendarMetadata]! |
calendarArrayMetadata:[CalendarArrayMetadata]! |
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
.
Diferencia entre metadatos normales y de matriz
Tenga en cuenta que StringMetadata
y StringArrayMetadata
hacen referencia a lo que se almacena en el repositorio, no a cómo se recuperan.
Por ejemplo, llamando al campo stringMetadata
, recibirá una matriz de todos los metadatos almacenados en el repositorio como String
, y si llama a stringArrayMetadata
recibirá una matriz de todos los metadatos almacenados en el repositorio como String[]
.
Consulte Consulta de muestra para metadatos: enumera los metadatos de los premios titulados GB.
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
}
}
}
Tenga en cuenta que el campo _variations
no contiene una variación master
, ya que técnicamente los datos originales (referenciados como Principal en la IU) no se consideran una variación explícita.
Consulte Consulta de muestra: todas las ciudades con una variación con nombre.
Si la variación dada no existe para un Fragmento de contenido, los datos originales (también conocidos como la variación principal) se devuelven como una predeterminada (alternativa).
GraphQL permite colocar variables en la consulta. Para obtener más información, consulte 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).
Aplique un filtro, si desea restringir la lista a autores que proporcionan la variación especificada (y omitir autores que recurren a los datos originales):
query($variation: String!) {
authorList(variation: $variation, filter: {
_variation: {
_expressions: {
value: $variation
}
}
}) {
items {
_variation
lastName
firstName
}
}
}
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
}
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:
Operador | Tipo(s) | La expresión es correcta si… |
---|---|---|
EQUALS |
String , ID , Boolean |
… el valor es exactamente el mismo que el contenido del campo |
EQUALS_NOT |
String , ID |
… el valor no es igual que el contenido del campo |
CONTAINS |
String |
… el contenido del campo contiene el valor ({ value: "mas", _op: CONTAINS } coincidirá con Christmas , Xmas , master …) |
CONTAINS_NOT |
String |
… el contenido del campo no contiene el valor |
STARTS_WITH |
ID |
… el ID empieza con un determinado valor ({ value: "/content/dam/", _op: STARTS_WITH coincidirá con /content/dam/path/to/fragment , pero no con /namespace/content/dam/something |
EQUAL |
Int , Float |
… el valor es exactamente el mismo que el contenido del campo |
UNEQUAL |
Int , Float |
… el valor no es igual que el contenido del campo |
GREATER |
Int , Float |
… el contenido del campo es mayor que el valor |
GREATER_EQUAL |
Int , Float |
… el contenido del campo es mayor o igual al valor |
LOWER |
Int , Float |
… el contenido del campo es menor que el valor |
LOWER_EQUAL |
Int , Float |
… el contenido del campo es menor o igual que el valor |
AT |
Calendar , Date , Time |
… el contenido del campo es exactamente el mismo que el valor (incluida la configuración de zona horaria) |
NOT_AT |
Calendar , Date , Time |
… el contenido del campo no es igual que el valor |
BEFORE |
Calendar , Date , Time |
… el punto en el tiempo indicado por el valor es anterior al indicado por el contenido del campo |
AT_OR_BEFORE |
Calendar , Date , Time |
… el punto en el tiempo indicado por el valor es anterior o igual al indicado por el contenido del campo |
AFTER |
Calendar , Date , Time |
… el punto en el tiempo indicado por el valor es posterior al indicado por el contenido del campo |
AT_OR_AFTER |
Calendar , Date , Time |
… el punto en el tiempo indicado por el valor es posterior o igual al indicado por el contenido del campo |
Algunos tipos también permiten especificar opciones adicionales que modifican como se evalúa una expresión:
Opción | Tipo(s) | Descripción |
---|---|---|
_ignoreCase |
String |
Omite las mayúsculas y minúsculas de una cadena, por ejemplo, un valor de time coincidirá con TIME , time , tImE … |
_sensitiveness |
Float |
Permite un cierto margen para que los valores float se consideren iguales (para sortear las limitaciones técnicas debidas a la representación interna de los valores float ; debe evitarse, ya que esta opción podría repercutir negativamente en el rendimiento |
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 correctaAND
: 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:
lastName
en el filtro para lastName
en el Tipo de datos (campo))_expressions
, que proporciona el conjunto de expresiones, y el campo _logOp
que define el operador lógico con el que deben combinarse las expresionesvalue
) y el operador (campo _operator
), el contenido de un campo debe compararse conTenga 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
Para obtener el mejor rendimiento, considere Actualizar los fragmentos de contenido para paginación y ordenación en el filtrado de GraphQL.
Esta función permite ordenar los resultados de la consulta según un campo especificado.
Los criterios de clasificación son los siguientes:
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
.
Esto puede tener un impacto negativo en el rendimiento.
Por ejemplo:
query {
articleList(sort: "authorFragment.lastName") {
items {
title
authorFragment {
firstName
lastName
birthDay
}
slug
}
}
}
Para obtener el mejor rendimiento, considere Actualizar los fragmentos de contenido para paginación y ordenación en el filtrado de GraphQL.
Esta función permite realizar paginación en los 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
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 devolverlimit
: especifica el número máximo de conjuntos de datos que se van a devolverPor 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
}
}
}
}
La paginación requiere un orden de clasificación estable para funcionar correctamente en varias consultas que soliciten diferentes páginas del mismo conjunto de resultados. De forma predeterminada, utiliza la ruta del repositorio de cada elemento del conjunto de resultados para asegurar que el orden sea siempre el mismo. Si se utiliza un orden de clasificación diferente y si esa clasificación no se puede realizar en el nivel de consulta JCR, se produce un impacto negativo en el rendimiento, ya que todo el conjunto de resultados debe cargarse en la memoria antes de que se puedan determinar las páginas.
Cuanto mayor sea el desplazamiento, más tiempo tardará en omitir los elementos del conjunto de resultados completo de la consulta JCR. Una solución alternativa para grandes conjuntos de resultados es utilizar la consulta paginada con el método first
y after
.
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.50
.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
}
}
}
De forma predeterminada, la paginación utiliza el UUID del nodo del repositorio que representa el fragmento para ordenar a fin de garantizar que el orden de los resultados sea siempre el mismo. Cuando se utiliza sort
, el UUID se utiliza implícitamente para garantizar una clasificación única; incluso para dos elementos con claves de clasificación idénticas.
Debido a limitaciones técnicas internas, el rendimiento se degradará si se aplica clasificación y filtrado en los campos anidados. Por lo tanto, se recomienda utilizar campos de filtro/clasificación almacenados en el nivel raíz. Esta es también la forma recomendada si desea consultar grandes conjuntos de resultados paginados.
La entrega de imágenes optimizadas para la web permite utilizar una consulta de Graphql para lo siguiente:
Solicitar una URL a una imagen de recursos AEM
Pase parámetros con la consulta para que se genere y devuelva automáticamente una representación específica de la imagen
La representación especificada no se almacena en AEM Assets. La representación se genera y se conserva en la caché durante un breve período.
Devolución de la URL como parte del envío JSON
Puede utilizar AEM para lo siguiente:
Esto significa que los comandos se aplican durante la ejecución de la consulta, de la misma manera que los parámetros de URL en las solicitudes de GET para esas imágenes.
Esto permite crear de forma dinámica representaciones de imágenes para la entrega JSON, lo que evita tener que crear y almacenar manualmente esas representaciones en el repositorio.
La solución de GraphQL significa que puede hacer lo siguiente:
use _dynamicUrl
en la referencia de ImageRef
añada _assetTransform
al encabezado de lista donde se definen los filtros
AssetTransform
(_assetTransform
) se utiliza para efectuar las solicitudes de transformación de URL.
La estructura y la sintaxis son las siguientes:
format
: una enumeración con todos los formatos admitidos por su extensión: GIF, PNG, PNG8, JPG, PJPG, BJPG, WEBP, WEBPLL o WEBPLYseoName
: una cadena que se utiliza como nombre de archivo en lugar del nombre de nodocrop
: una subestructura de fotograma, si se omite la anchura o la altura, estas se utilizan como el mismo valor
xOrigin
: el origen x del fotograma, es obligatorioyOrigin
: el origen y del fotograma, es obligatoriowidth
: la anchura del fotogramaheight
: la altura del fotogramasize
: una subestructura de dimensión, si se omite la anchura o la altura, estas se utilizan como el mismo valor
width
: la anchura de la dimensiónheight
: la altura de la dimensiónrotation
: una enumeración de todas las rotaciones admitidas: R90, R180, R270flip
: una enumeración de HORIZONTAL, VERTICAL, HORIZONTAL_AND_VERTICALquality
: un entero entre 1 y 100 que indica el porcentaje de calidad de la imagenwidth
: un entero que define la anchura de la imagen de salida, pero que el Generador de imágenes ignorapreferWebp
: un booleano que indica si se prefiere webp (el valor predeterminado es falso)La transformación de URL está disponible para todos los tipos de consulta: por ruta, lista o paginada.
A continuación se muestra una consulta de ejemplo con un conjunto completo de parámetros:
{
articleList(
_assetTransform: {
format:GIF
seoName:"test"
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
El siguiente ejemplo muestra el uso de una sola variable de consulta:
query ($seoName: String!) {
articleList(
_assetTransform: {
format:GIF
seoName:$seoName
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
El siguiente ejemplo muestra el uso de múltiples variables de consulta:
query ($seoName: String!, $format: AssetTransformFormat!) {
articleList(
_assetTransform: {
format:$format
seoName:$seoName
crop:{
xOrigin:10
yOrigin:20
width:50
height:45
}
size:{
height:100
width:200
}
rotation:R90
flip:HORIZONTAL_AND_VERTICAL
quality:55
width:123
preferWebp:true
}
) {
items {
_path
featuredImage {
... on ImageRef {
_dynamicUrl
}
}
}
}
}
Si guarda la consulta como una consulta persistente (por ejemplo, con el nombre dynamic-url-x
), puede ejecutar la consulta persistente directamente.
Por ejemplo, para ejecutar directamente los ejemplos anteriores (guardados como consultas persistentes), utilice las siguientes direcciones URL:
Parámetro único; consulta persistente con el nombre dynamic-url-x
http://localhost:4502/graphql/execute.json/wknd-shared/dynamic-url-x;seoName=xxx
La respuesta será la siguiente:
Múltiples parámetros; consulta persistente con el nombre dynamic
http://localhost:4502/graphql/execute.json/wknd-shared/dynamic;seoName=billiboy;format=GIF;
El ;
final es obligatorio para terminar de forma limpia la lista de parámetros.
Existen las siguientes limitaciones:
Modificadores aplicados a todas las imágenes que forman parte de la consulta (parámetros globales)
Almacenamiento en caché de encabezados
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 necesita un solo resultado:
Si espera una lista de resultados:
List
al nombre del modelo; por ejemplo, cityList
Podrá hacer lo siguiente:
Clasificación de los resultados
ASC
: ascendenteDESC
: descendenteDevuelva una página de resultados utilizando lo siguiente:
Consulte Consulta de muestra: toda la información acerca de todas las ciudades
El filtro includeVariations
está incluido en los tipos de consulta List
y Paginated
. Para recuperar las variaciones de fragmentos de contenido en los resultados de la consulta, el filtro includeVariations
debe establecerse en true
.
El filtro includeVariations
y el campo generado por el sistema _variation
no se pueden usar juntos en la misma definición de consulta.
Si desea utilizar un OR lógico:
_logOp: OR
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
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
_metadata
: para mostrar los metadatos del fragmento
_model
: permitir la consulta de un modelo de fragmento de contenido (ruta y título)
_path
: la ruta al fragmento de contenido dentro del repositorio
_reference
: para revelar referencias, incluyendo referencias en línea en el Editor de texto enriquecido
_variation
: para mostrar variaciones específicas dentro del fragmento de contenido
Si la variación dada no existe para un Fragmento de contenido, la variación principal se devuelve como una predeterminada (alternativa).
El campo generado por el sistema _variation
no se puede usar junto con el filtro includeVariations
.
Para envío de imágenes:
_dynamicUrl
: en la referencia ImageRef
_assetTransform
: en el encabezado de lista donde se definen los filtros
Consulte:
_tags
: para revelar los ID de los fragmentos de contenido o las variaciones que contienen etiquetas; se trata de una matriz de identificadores cq:tags
.
Las etiquetas también se pueden consultar enumerando los metadatos de un fragmento de contenido.
Y operaciones:
_operator
: aplicar operadores específicos; EQUALS
, EQUALS_NOT
, GREATER_EQUAL
, LOWER
, CONTAINS
, STARTS_WITH
_apply
: para aplicar condiciones específicas; por ejemplo, AT_LEAST_ONCE
_ignoreCase
: para ignorar el caso al consultar
Se admiten los tipos de unión de GraphQL:
Alternativa cuando se consultan fragmentos anidados:
Para acceder al punto de conexión de GraphQL desde un sitio web externo, debe configurar lo siguiente:
Consulte Autenticación para consultas de GraphQL de AEM remotas en fragmentos de contenido.
Preguntas que han surgido:
P: “¿En qué se diferencia la API de GraphQL para AEM de la API Generador de consultas?”
¿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.