Création d’une requête API - Configuration découplée

Dernière mise à jour : 2023-12-05

Découvrez comment utiliser l’API GraphQL pour une diffusion découplée du contenu du fragment de contenu et l’API REST AEM Assets pour gérer les fragments de contenu.

En quoi consistent les API REST GraphQL et Assets ?

Maintenant que vous avez créé des fragments de contenu, vous pouvez utiliser les API d’AEM pour une diffusion découplée.

Le reste de ce guide porte sur l’accès à GraphQL et la diffusion de fragments de contenu.

Activation du point d’entrée GraphQL

Avant de pouvoir utiliser les API GraphQL, un point d’entrée GraphQL doit être créé.

  1. Accédez à Outils, Général, puis sélectionnez GraphQL.

  2. Sélectionnez Créer.

  3. La boîte de dialogue Créer un point d’entrée GraphQL s’ouvre. Vous pouvez spécifier ici les éléments suivants :

    • Nom : nom du point d’entrée ; vous pouvez saisir du texte.
    • Utiliser le schéma GraphQL fourni par: utilisez la liste déroulante pour sélectionner la configuration requise.
  4. Confirmez en sélectionnant Créer.

  5. Dans la console, un Chemin d’accès s’affiche désormais en fonction de la configuration créée précédemment. Ce chemin d’accès est utilisé pour exécuter des requêtes GraphQL.

    /content/cq:graphql/<configuration-name>/endpoint
    

Plus d’informations sur l’activation des points d’entrée GraphQL se trouvent ici.

Requête de contenu à l’aide de GraphQL avec GraphiQL

Les architectes d’informations créent des requêtes pour leurs points d’entrée de canal afin de diffuser du contenu. Considérez ces requêtes une seule fois par point d’entrée et par modèle. Pour les besoins de ce guide de prise en main, il suffit d’en créer une.

GraphiQL est un IDE inclus dans votre environnement AEM ; il est accessible/visible après la configuration des points d’entrée.

  1. Connectez-vous à AEM as a Cloud Service et accédez à l’interface GraphiQL :

    Vous pouvez accéder à l’éditeur de requêtes à partir de :

    • Outils > Général > Éditeur de requêtes GraphQL
    • directement ; par exemple, http://localhost:4502/aem/graphiql.html
  2. L’IDE GraphiQL est un éditeur de requêtes intégré au navigateur pour GraphQL. Vous pouvez l’utiliser pour créer des requêtes permettant de récupérer des fragments de contenu afin de les diffuser de manière découplée en mode JSON.

    • La liste déroulante en haut à droite vous permet de sélectionner le point de terminaison.
    • Un panneau de gauche répertorie les requêtes persistantes (le cas échéant).
    • Le panneau du milieu à gauche vous permet de créer votre requête.
    • Le volet au milieu à droite affiche les résultats.
    • L’éditeur de requêtes comprend la saisie du code et des touches d’accès rapide pour exécuter facilement la requête.

    Éditeur GraphiQL

  3. En supposant que le modèle que vous avez créé s’appelle person, avec les champs firstName, lastName et position, vous pouvez créer une requête simple pour récupérer le contenu du fragment de contenu.

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. Entrez la requête dans le volet de gauche.
    Requête GraphiQL

  5. Cliquez sur le bouton Exécuter la requête ou utilisez le raccourci Ctrl-Enter pour faire apparaître les résultats sous la forme JSON dans le volet de droite.
    Résultats GraphiQL

  6. Dans le coin supérieur droit de la page, cliquez sur le lien Documents pour afficher la documentation contextuelle afin que vous puissiez créer des requêtes qui s’adaptent à vos propres modèles.
    Documentation GraphiQL

GraphQL permet d’utiliser des requêtes structurées qui peuvent cibler non seulement des jeux de données spécifiques ou des objets de données particuliers, mais peuvent également fournir des éléments spécifiques d’objets, des résultats imbriqués, prendre en charge des variables de requête, etc.

GraphQL permet d’éviter les requêtes d’API itératives ainsi que la surdiffusion, et permet au contraire la diffusion en masse de ce qui est nécessaire au rendu en réponse à une requête d’API unique. Le fichier JSON produit peut être utilisé pour diffuser des données vers d’autres sites ou applications.

Étapes suivantes

C’est terminé ! Vous possédez maintenant une compréhension de base de la gestion de contenu découplée dans AEM. Bien entendu, il existe beaucoup d’autres ressources que vous pouvez approfondir pour une compréhension complète des fonctionnalités disponibles.

Sur cette page