SDK AEM Headless
Le SDK d’AEM Headless est un ensemble de bibliothèques qui peuvent être utilisées par les clients pour interagir rapidement et facilement avec les API d’AEM Headless via HTTP.
Le SDK d’AEM Headless est disponible pour diverses plateformes :
Requêtes GraphQL persistantes
Effectuer des requêtes sur AEM avec GraphQL à l’aide de requêtes persistantes (par opposition aux requêtes GraphQL définies par le client) permet aux développeurs et développeuses de conserver une requête (mais pas ses résultats) dans AEM, puis de demander que la requête soit exécutée par nom. Les requêtes persistantes sont similaires au concept des procédures stockées dans les bases de données SQL.
Les requêtes persistantes sont plus performantes que les requêtes GraphQL définies par le client, car les requêtes persistantes sont exécutées à l’aide de HTTP GET, qui peut être mis en cache sur les niveaux de réseau CDN et du Dispatcher d’AEM. Les requêtes persistantes définissent également une API et dissocient la nécessité pour le développeur ou la développeuse de comprendre les détails de chaque modèle de fragment de contenu.
Exemples de code persisted-graphql-queries-code-examples
Vous trouverez ci-dessous des exemples de code sur la manière d’exécuter une requête GraphQL persistante sur AEM.
Installez @adobe/aem-headless-client-js en exécutant la commande npm install
à partir de la racine de votre projet Node.js.
code language-none |
---|
|
Cet exemple de code montre comment effectuer des requêtes sur AEM à l’aide du module npm @adobe/aem-headless-client-js utilisant une syntaxe async/await
. Le SDK d’AEM Headless pour JavaScript prend également en charge la syntaxe de promesse.
Ce code suppose qu’une requête persistante avec le nom wknd/adventureNames
a été créée sur l’instance de création AEM et publiée sur l’instance de publication AEM.
code language-javascript |
---|
|
Installez @adobe/aem-headless-client-js en exécutant la commande npm install
à partir de la racine de votre projet React.
code language-none |
---|
|
Cet exemple de code montre comment utiliser le hook React useEffect(…)pour exécuter un appel asynchrone vers AEM GraphQL.
L’utilisation de useEffect
pour effectuer l’appel GraphQL asynchrone dans React est utile car :
- cela fournit un wrapper synchrone pour l’appel asynchrone à AEM ;
- cela réduit les nouvelles requêtes inutiles dans AEM.
Ce code suppose qu‘une requête persistante avec le nom wknd-shared/adventure-by-slug
a été créée sur l’instance de création AEM et publiée sur l’instance de publication AEM à l’aide de GraphiQL.
code language-javascript |
---|
|
Appelez le hook React personnalisé useEffect
depuis un autre endroit dans un composant React.
code language-javascript |
---|
|
De nouveaux hooks useEffect
peuvent être créés pour chaque requête persistante utilisée par l’application React.
Requêtes GraphQL
AEM prend en charge les requêtes GraphQL définies par le client, mais il est recommandé d’utiliser les requêtes GraphQL persistantes dans AEM.
Webpack 5 et versions ultérieures
Le SDK JS AEM Headless a des dépendances sur util
, ce qui n’est pas inclus par défaut dans Webpack 5 et versions ultérieures. Si vous utilisez Webpack 5 ou une version ultérieure et recevez l’erreur suivante :
Compiled with problems:
× ERROR in ./node_modules/@adobe/aio-lib-core-errors/src/AioCoreSDKErrorWrapper.js 12:13-28
Module not found: Error: Can't resolve 'util' in '/Users/me/Code/wknd-headless-examples/node_modules/@adobe/aio-lib-core-errors/src'
BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.
This is no longer the case. Verify if you need this module and configure a polyfill for it.
If you want to include a polyfill, you need to:
- add a fallback 'resolve.fallback: { "util": require.resolve("util/") }'
- install 'util'
If you don't want to include a polyfill, you can use an empty module like this:
resolve.fallback: { "util": false }
Ajoutez les éléments devDependencies
suivants au fichier package.json
:
"devDependencies": {
"buffer": "npm:buffer@^6.0.3",
"crypto": "npm:crypto-browserify@^3.12.0",
"http": "npm:stream-http@^3.2.0",
"https": "npm:https-browserify@^1.0.0",
"stream": "npm:stream-browserify@^3.0.0",
"util": "npm:util@^0.12.5",
"zlib": "npm:browserify-zlib@^0.2.0"
},
Exécutez ensuite npm install
pour installer les dépendances.