Bonnes pratiques pour la configuration et l’utilisation d’AEM GraphQL avec des fragments de contenu best-practices-setup-use-aem-graphql-content-fragments

Ces instructions résument les bonnes pratiques recommandées pour configurer, configurer et utiliser AEM avec GraphQL et les fragments de contenu.

Prise en main getting-started

Pour vous aider à vous mettre à niveau :

Configuration setup

Pour configurer AEM GraphQL en toute sécurité en vue de l’utiliser avec les fragments de contenu et vos applications, vous devez configurer divers composants.

Création de points de terminaison GraphQL (y compris la sécurité) graphql-endpoint-creation

Le point d’entrée est le chemin utilisé pour accéder à GraphQL pour AEM. Ces points de terminaison doivent être créés et publiés afin qu’ils soient accessibles en toute sécurité.

Détails details-graphql-endpoint-creation

Gérer les points d’entrée GraphQL dans AEM

Environnements environments-graphql-endpoint-creation

Les points de fin doivent être configurés dans :

  • Création
  • Prévisualisation
  • Publier

Pour :

  • Développement
  • Tests
  • Production

Mise en cache AEM Dispatcher dispatcher-caching

NOTE
Si la mise en cache dans Dispatcher est activée, la fonction Configuration CORS n’est pas nécessaire et peut donc être ignoré.

La mise en cache des requêtes persistantes n’est pas activée par défaut dans Dispatcher. L’activation par défaut n’est pas possible, car les clients qui utilisent le partage de ressources cross-origin (CORS) avec plusieurs origines doivent examiner et éventuellement mettre à jour leur configuration Dispatcher.

Détails details-dispatcher-caching

Requêtes persistantes GraphQL - Activation de la mise en cache dans Dispatcher

Environnements environments-dispatcher-caching

Dispatcher est généralement configuré pour :

  • Publier : production

Configuration CORS cors-setup

NOTE
Si la mise en cache dans la variable AEM Dispatcher est activée, la configuration CORS n’est pas nécessaire. Cette section peut donc être ignorée.

Pour accéder au point d’entrée GraphQL, une politique CORS doit être configurée et ajoutée à un projet AEM qui soit déployé vers AEM via Cloud Manager. Vous devez pour cela ajouter un fichier de configuration CORS OSGi approprié pour le ou les points d’entrée souhaités.

Détails details-cors-setup

Configuration du partage des ressources cross-origin (CORS)

Environnements environments-cors-setup

La norme CORS est généralement configurée pour :

  • Publier : production

Authentification authentication

Un des principaux cas d’utilisation de l’API Adobe Experience Manager as a Cloud Service (AEM) GraphQL pour la diffusion de fragments de contenu consiste à accepter les requêtes distantes provenant d’applications ou de services tiers. Ces requêtes à distance peuvent nécessiter un accès authentifié à l’API afin de sécuriser la diffusion de contenu découplé.

Détails details-authentication

Authentification pour les requêtes AEM GraphQL distantes sur les fragments de contenu

Environnements environments-authentication

L’authentification est généralement configurée pour :

  • Prévisualisation
  • Publier

Pour :

  • Développement
  • Tests
  • Production

Autorisations permissions

Avec une mise en œuvre sans interface, plusieurs domaines de sécurité et d’autorisations doivent être pris en compte. Les autorisations et les personnages peuvent être considérés de la même manière pour l’environnement AEM de Création ou de Publication. Chaque environnement contient des personnages différents et a des besoins différents.

Détails details-permissions

Considérations relatives aux autorisations pour le contenu découplé

Environnements environments-permissions

Les autorisations sont généralement configurées pour :

  • Création
  • Prévisualisation
  • Publier

Pour :

  • Développement
  • Tests
  • Production

Utilisation d’un réseau de diffusion de contenu (CDN) cdn

Les requêtes GraphQL et leurs réponses JSON peuvent être mises en cache si elles sont ciblées comme GET lors de l’utilisation d’un réseau de diffusion de contenu. En revanche, les demandes non mises en cache peuvent être très (ressources) coûteuses et lentes à traiter, avec des effets potentiellement néfastes supplémentaires sur les ressources de l’origine.

Détails details-cdn

Réseau de diffusion de contenu dans AEM as a Cloud Service

Environnements environments-cdn

Un réseau de diffusion de contenu est généralement configuré pour :

  • Publier : production

Configuration et création de fragments de contenu cconfigure-create-content-fragments

AEM GraphQL est utilisé pour récupérer des informations de vos fragments de contenu. Ils doivent être configurés, puis une structure et un emplacement définis, avant de pouvoir créer le contenu.

Détails details-content-fragments

Environnements eenvironments-content-fragments

Les fragments de contenu sont définis, créés, testés, publiés et accessibles sur :

  • Création
  • Prévisualisation
  • Publier

Pour :

  • Développement
  • Tests
  • Production

Utilisation d’AEM GraphQL use-aem-graphql

Optimisation des requêtes GraphQL optimize-graphql-queries

Ces instructions sont fournies pour vous aider à éviter les problèmes de performances liés à vos requêtes GraphQL.

Détails details-optimize-graphql-queries

Optimisation des requêtes GraphQL.

NOTE
Les instructions d’optimisation portent sur la configuration du cache, déjà abordées dans la section Configuration.

Accès à GraphQL à partir de vos applications access-graphql-from-your-apps

AEM CMS sans interface donne aux développeurs la liberté de créer et de proposer des expériences exceptionnelles en utilisant les langages, les structures et les outils qu’ils connaissent déjà.

Détails details-your-apps

Environnements environments-your-apps

Les applications sont généralement développées, testées et utilisées sur :

  • Prévisualisation
  • Publier

Pour :

  • Développement
  • Tests
  • Production

Ressources supplémentaires

Pour plus d’informations sur AEM GraphQL et les fragments de contenu, voir :

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab