Capítulo 4 - Definición de plantillas de servicios de contenido

El capítulo 4 del tutorial sin encabezado de AEM cubre el papel de las plantillas editables de AEM en el contexto de los servicios de contenido de AEM. Las plantillas editables se utilizan para definir la estructura de contenido JSON que los servicios de contenido de AEM exponen a los clientes mediante la composición de los componentes de AEM habilitados para los servicios de contenido.

Explicación de la función de las plantillas en los servicios de contenido de AEM

Las plantillas editables de AEM se utilizan para definir los puntos finales HTTP a los que se accederá para exponer el contenido del evento como JSON.

Tradicionalmente, las plantillas editables de AEM se utilizan para definir páginas web, aunque este uso es simplemente una convención. Las plantillas editables se pueden utilizar para componer cualquier conjunto de contenido; cómo se accede a ese contenido: como HTML en un explorador, como JSON consumido por JavaScript (AEM SPA Editor) o una aplicación móvil es una función del modo en que se solicita esa página.

En los servicios de contenido de AEM, se utilizan plantillas editables para definir cómo se exponen los datos JSON.

Para la aplicación WKND Mobile, crearemos una única plantilla editable que se utilizará para dirigir un único extremo de API. Aunque este ejemplo es sencillo de ilustrar los conceptos de AEM sin encabezado, puede crear varias páginas (o puntos finales) cada una que exponga diferentes conjuntos de contenido para crear una API más compleja y mejor organizada.

Explicación del punto final de la API

Para comprender cómo componer nuestro punto final de API y comprender qué contenido debe exponerse a nuestra aplicación WKND Mobile, volvamos a examinar el diseño.

Descomposición de página de la API de eventos

Como podemos ver, tenemos tres conjuntos lógicos de contenido para proporcionar a la aplicación móvil.

  1. El logotipo
  2. La Línea de etiqueta
  3. La lista de Eventos

Para ello, podemos asignar estos requisitos a los componentes AEM (y, en nuestro caso, a los componentes principales de WCM de AEM) para exponer el contenido necesario como JSON.

  1. El Logotipo se mostrará a través de un Componente de imagen
  2. La Línea de etiqueta se mostrará a través de un Componente de texto
  3. La lista de Eventos se mostrará a través de un componente Lista de fragmentos de contenido que, a su vez, hace referencia a un conjunto de fragmentos de contenido de eventos.
NOTA

Para admitir la exportación JSON de páginas y componentes del servicio de contenido de AEM, las páginas y los componentes deben derivarse de los componentes principales de WCM de AEM.

Los componentes principales de WCM de AEM tienen una funcionalidad integrada que admite un esquema JSON normalizado de páginas y componentes exportados. Todos los componentes de WKND Mobile utilizados en este tutorial (Página, Imagen, Texto y Lista de fragmentos de contenido) se derivan de los componentes principales de WCM de AEM.

Definición de la plantilla de API de eventos

  1. Vaya a Herramientas > General > Plantillas >WKND Mobile.

  2. Cree la plantilla Events API:

    1. Toque Crear en la barra de acciones superior
    2. Seleccione la plantilla WKND Mobile - Empty Page
    3. Toque Siguiente en la barra de acciones superior
    4. Introduzca Events API en el campo Template Title
    5. Toque Crear en la barra de acciones superior
    6. Toque Abrir para abrir la nueva plantilla y editarla
  3. En primer lugar, permitimos los tres componentes de AEM identificados que necesitamos para modelar el contenido editando la Política del Contenedor de diseño raíz. Asegúrese de que el modo Structure está activo, seleccione Layout Container [Root] y pulse el botón Policy.

  4. En Propiedades > Componentes permitidos busque WKND Mobile. Habilite los siguientes componentes del grupo de componentes WKND Mobile para que se puedan utilizar en la página de API Events.

    • WKND Mobile > Image

      • El logotipo de la aplicación
    • WKND Mobile > Text

      • Texto introductorio de la aplicación
    • WKND Mobile > Content Fragment List

      • La lista de categorías de eventos disponibles para mostrar en la aplicación
  5. Toque la marca de verificación Listo en la esquina superior derecha cuando termine.

  6. ​Actualice la ventana del explorador para ver la nueva lista Componentes permitidos en el carril izquierdo.

  7. En el buscador de componentes del carril izquierdo, arrastre los siguientes componentes de AEM:

    1. Image para el logotipo
    2. Text para la línea de etiquetas
    3. Content Fragment List para los eventos
  8. Para cada uno de los componentes anteriores, selecciónelos y pulse el ​botón de desbloqueo.

  9. Sin embargo, asegúrese de que el contenedor de diseño esté bloqueado para evitar que se agreguen otros componentes o que se eliminen estos tres componentes.

  10. Pulse Información de página > Ver en Administración para volver a la lista de plantillas WKND Mobile. Seleccione la plantilla Events API recién creada y pulse Habilitar en la barra de acciones superior.

NOTA

Observe que los componentes utilizados para mostrar el contenido se añaden a la plantilla misma y se bloquean. Esto permite a los autores editar los componentes predefinidos, pero no añadir ni eliminar componentes de forma arbitraria, ya que cambiar la propia API podría alterar las suposiciones sobre la estructura de JSON y dejar de consumir aplicaciones. Todas las API deben ser estables.

Pasos siguientes

Opcionalmente, instale el paquete de contenido com.adobe.aem.guides.wknd-mobile.content.chapter-4.zip en AEM Author a través del Administrador de paquetes de AEM. Este paquete contiene las configuraciones y el contenido descritos en este y los capítulos anteriores del tutorial.

En esta página