Chapitre 4 - Définitr des modèles Content Services

Le chapitre 4 du tutoriel sur AEM Headless aborde le rôle des modèles modifiables d’AEM dans le contexte d’AEM Content Services. Les modèles modifiables sont utilisés pour définir la structure de contenu JSON qu’AEM Content Services expose aux clients et clientes via la composition des composants AEM activés pour Content Services.

Comprendre le rôle des modèles dans AEM Content Services

Les modèles modifiables AEM sont utilisés pour définir les points d’entrée HTTP accessibles pour exposer le contenu de l’événement au format JSON.

En général, les modèles modifiables AEM sont utilisés pour définir des pages web, mais cette utilisation est une simple convention. Les modèles modifiables peuvent être utilisés pour composer tout ensemble de contenu et mode d’accès de contenu : en tant que HTML dans un navigateur ou que JSON utilisé par JavaScript (éditeur de SPA AEM), ou encore en tant qu’application mobile. Cela dépend de la manière dont cette page est demandée.

Dans AEM Content Services, des modèles modifiables sont utilisés pour définir la manière dont les données JSON sont exposées.

Pour l’application WKND Mobile, nous allons créer un modèle modifiable unique utilisé pour générer un point d’entrée API unique. Bien que cet exemple simple permette d’illustrer les concepts d’AEM Headless, vous pouvez créer plusieurs pages (ou points d’entrée) exposant chaque ensemble de contenu afin de créer une API plus complexe et mieux organisée.

Comprendre le point d’entrée de l’API

Pour comprendre comment composer notre point d’entrée d’API et comprendre quel contenu doit être exposé à notre application WKND Mobile, nous allons revoir la conception.

Décomposition de page de l’API d’événements.

Comme nous pouvons le constater, nous disposons de trois ensembles logiques de contenu à fournir à l’application mobile.

  1. Le Logo.
  2. Le Ligne de balise.
  3. La liste des Événements.

Pour ce faire, nous pouvons mettre en correspondance ces exigences avec les composants AEM (et, dans notre cas, les composants AEM principaux de gestion de contenu web) afin d’exposer le contenu requis au format JSON.

  1. Le Logo est surfacé via un Composant d’image.
  2. La Ligne de balise est surfacée via un Composant de texte.
  3. La liste des Événements est surfacée via un Composant Liste de fragments de contenu qui, à son tour, fait référence à un ensemble de fragments de contenu d’événement.
NOTE
Pour prendre en charge l’exportation JSON des pages et composants par AEM Content Services, ces derniers doivent dériver des composants principaux AEM de la gestion de contenu Web.
Les Composants principaux AEM de gestion de contenu web disposent d’une fonctionnalité intégrée pour prendre en charge un schéma JSON normalisé des pages et composants exportés. Tous les composants mobiles WKND utilisés dans ce tutoriel (Page, Image, Texte et Liste de fragments de contenu) sont dérivés des composants principaux de gestion de contenu web d’AEM.

Définir le modèle d’API d’événement

  1. Accédez à Outils > Général > Modèles >WKND Mobile.

  2. Créez le modèle Events API  :

    1. Appuyez sur Créer dans la barre d’actions supérieure.
    2. Sélectionnez le modèle WKND Mobile - Empty Page.
    3. Appuyez sur Suivant dans la barre d’actions supérieure.
    4. Entrez Events API dans le champ Titre du modèle.
    5. Appuyez sur Créer dans la barre d’actions supérieure.
    6. Appuyez sur Ouvrir pour ouvrir le nouveau modèle à modifier.
  3. Tout d’abord, nous autorisons les trois composants AEM identifiés dont nous avons besoin pour modéliser le contenu en modifiant la Stratégie du Conteneur de disposition racine. Assurez-vous que le mode Structure est actif, sélectionnez Layout Container [Root], puis appuyez sur le bouton Stratégie.

  4. Sous Propriétés > Composants autorisés, recherchez WKND Mobile. Autorisez les composants suivants du groupe de composants WKND Mobile, afin qu’ils puissent être utilisés sur la page d’API Events.

    • WKND Mobile > Image

      • Logo de l’application.
    • WKND Mobile > Text

      • Texte d’introduction de l’application.
    • WKND Mobile > Content Fragment List

      • Liste des catégories d’événement disponibles pour affichage dans l’application.
  5. Cochez la case Terminé en haut à droite lorsque vous avez terminé.

  6. Actualisez la fenêtre du navigateur pour afficher la liste des nouveaux Composants autorisés dans le rail de gauche.

  7. Dans l’outil de recherche de composants du rail de gauche, faites glisser les composants AEM suivants :

    1. Image pour le Logo.
    2. Text pour la Ligne de balise.
    3. Content Fragment List pour les événements.
  8. Pour chacun des composants ci-dessus, sélectionnez-les et appuyez sur le bouton Déverrouiller.

  9. Cependant, assurez-vous que le conteneur de disposition est verrouillé pour empêcher l’ajout d’autres composants ou la suppression de ces trois composants.

  10. Appuyez sur Informations sur la page > Afficher dans Admin pour revenir à la liste des modèles WKND Mobile. Sélectionnez le modèle Events API nouvellement créé et appuyez sur Activer dans la barre d’actions supérieure.

NOTE
Notez que les composants utilisés pour surfacer le contenu sont ajoutés au modèle lui-même et verrouillés. Cela permet aux auteurs et autrices de modifier les composants prédéfinis, mais pas d’ajouter ou de supprimer arbitrairement des composants, car la modification de l’API elle-même peut rompre les hypothèses autour de la structure JSON et interrompre les applications consommatrices. Toutes les API doivent être stables.

Étapes suivantes

Si vous le souhaitez, vous pouvez installer le package de contenu com.adobe.aem.guides.wknd-mobile.content.chapter-4.zip sur l’instance de création AEM via le Gestionnaire de packages AEM. Ce package contient les configurations et le contenu décrits dans ce tutoriel et dans les chapitres précédents.

recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4