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

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

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

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

Les modèles modifiables traditionnellement AEM sont utilisés pour définir des pages web, mais cette utilisation est simplement une convention. Les modèles modifiables peuvent être utilisés pour composer n’importe quel ensemble de contenu. mode d’accès à ce contenu : en tant que code HTML dans un navigateur, en tant que code JSON utilisé par JavaScript (AEM Éditeur SPA) ou une application mobile est une fonction 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 qui sera utilisé pour générer un point de terminaison API unique. Bien que cet exemple soit simple pour illustrer les concepts d’AEM sans affichage, vous pouvez créer plusieurs pages (ou points de fin) exposant chacun différents ensembles de contenu afin de créer une API plus complexe et mieux organisée.

Présentation du point de terminaison de l’API

Pour comprendre comment composer notre point de terminaison 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. Logo
  2. Ligne de balise
  3. Liste des Événements

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

  1. Le logo sera affiché via un composant d’image
  2. La ligne de balise sera affichée via un composant Texte
  3. La liste des Événements sera affichée via un composant Liste de fragments de contenu qui, à son tour, référence un ensemble de fragments de contenu d’événement.
REMARQUE

Pour prendre en charge l’exportation JSON de pages et de composants par AEM Content Service, les pages et les composants doivent dériver d’AEM composants principaux WCM.

Les composants principaux de la gestion de contenu web d’AEM 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 WKND Mobile utilisés dans ce tutoriel (Page, Image, Texte et Liste de fragments de contenu) sont dérivés des composants principaux de la gestion de contenu web d’AEM.

Définition du 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. Saisissez 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 d’AEM identifiés dont nous avons besoin pour modéliser le contenu en modifiant la Stratégie de la racine Conteneur de mises en page. Vérifiez que le mode Structure est principal, 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 de l’API Events.

    • WKND Mobile > Image

      • Le logo de l’application
    • WKND Mobile > Text

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

      • Liste des catégories d’événements disponibles pour affichage dans l’application.
  5. Appuyez sur la coche Terminé dans le coin supérieur droit lorsque vous avez terminé.

  6. ​Actualisez la fenêtre du navigateur pour afficher la nouvelle liste de 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 de ​déverrouillage.

  9. Cependant, assurez-vous que le conteneur de mises en page est verrouillé pour empêcher l’ajout d’autres composants ou que ces trois composants ne soient pas supprimés.

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

REMARQUE

Notez que les composants utilisés pour faire surface du contenu sont ajoutés au modèle lui-même et verrouillés. Cela permet aux auteurs 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

Vous pouvez éventuellement installer le module de contenu com.adobe.aem.guides.wknd-mobile.content.chapter-4.zip sur l’auteur AEM via AEM Gestionnaire de modules. Ce package contient les configurations et le contenu décrits dans ce tutoriel et dans les chapitres précédents.

Sur cette page