Création d’une requête API - Configuration sans affichage

Découvrez comment utiliser l’API GraphQL pour diffuser sans interface du contenu de fragment de contenu et AEM l’API REST Assets pour gérer les fragments de contenu.

REMARQUE

Certaines fonctionnalités de cette fonctionnalité sont disponibles dans le canal de version préliminaire. En particulier, les fonctionnalités liées aux requêtes persistantes.

Voir Documentation sur les canaux de version préliminaire pour plus d’informations sur l’activation de la fonctionnalité dans votre environnement.

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.
    • Utilisation du schéma GraphQL fourni par: utilisez la liste déroulante pour sélectionner la configuration requise.
  4. Confirmez avec Créer.

  5. Dans la console, une Chemin s’affiche désormais en fonction de la configuration créée précédemment. Il s’agit du chemin utilisé pour exécuter des requêtes GraphQL.

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

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

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

Les architectes de l’information doivent concevoir des requêtes pour leurs points d’entrée de canaux afin de diffuser du contenu. Ces requêtes ne doivent généralement être prises en compte qu’une seule fois par point d’entrée et par modèle. Pour les besoins de ce guide de prise en main, nous ne devrons en créer qu’une.

GraphiQL est un IDE qui peut être installé sur un environnement AEM. Suivez les étapes de la section Utilisation de l’IDE GraphiQL pour effectuer l’installation sur votre environnement AEM.

  1. Connectez-vous à AEM en 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 afin de récupérer des fragments de contenu afin de les diffuser sans affichage au format 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 panneau du milieu droit 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 nous avons créé s’appelle person, avec les champs firstName, lastName et position, nous pouvons créer une requête simple pour récupérer le contenu de notre 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. Cliquez sur le lien Docs en haut à droite de la page pour afficher la documentation contextuelle afin de vous aider à créer vos requêtes adaptées à vos propres modèles.
    Documentation GraphiQL

GraphQL permet d’utiliser des requêtes structurées qui peuvent cibler non seulement des ensembles de données spécifiques ou des objets de données individuels, mais peuvent également fournir des éléments spécifiques des objets, des résultats imbriqués, prend en charge les variables de requête, et bien plus encore.

GraphQL permet d’éviter les requêtes d’API itératives ainsi que la surdiffusion, et permet la diffusion en masse de ce qui est exactement nécessaire pour le 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