API sin encabezado de AEM y React
- Se aplica a:
- Experience Manager as a Cloud Service
- Temas:
- Fragmentos de contenido
Creado para:
- Intermedio
- Desarrollador
Le damos la bienvenida a este capítulo del tutorial, en el que exploraremos la configuración de una aplicación de React para conectarla con las API de Adobe Experience Manager (AEM) sin encabezado mediante AEM sin encabezado SDK. Cubriremos la recuperación de datos de fragmentos de contenido de las API de GraphQL de AEM y su visualización en la aplicación React.
Las API sin encabezado de AEM permiten acceder al contenido de AEM desde cualquier aplicación cliente. Le guiaremos a través de la configuración de su aplicación React para conectarse a las API de AEM sin encabezado mediante AEM Headless SDK. Esta configuración establece un canal de comunicación reutilizable entre su aplicación React y AEM.
A continuación, utilizaremos la SDK sin encabezado de AEM para recuperar datos de fragmentos de contenido de las API de GraphQL de AEM. Los fragmentos de contenido en AEM proporcionan una administración de contenido estructurada. Al utilizar AEM Headless SDK, puede consultar y recuperar fácilmente datos de fragmentos de contenido mediante GraphQL.
Una vez que tengamos los datos del fragmento de contenido, los integraremos en su aplicación React. Aprenderá a dar formato y mostrar los datos de una manera atractiva. Cubriremos las prácticas recomendadas para administrar y procesar datos de fragmentos de contenido en los componentes de React, lo que garantiza una integración perfecta con la interfaz de usuario de la aplicación.
A lo largo del tutorial, proporcionaremos explicaciones, ejemplos de código y sugerencias prácticas. Al final, podrá configurar la aplicación React para conectarse a las API de AEM sin encabezado, recuperar datos de fragmentos de contenido mediante AEM Headless SDK y mostrarlos sin problemas en la aplicación React. ¡Vamos a empezar!
Clonar la aplicación React
-
Clone la aplicación desde Github ejecutando el siguiente comando en la línea de comandos.
$ git clone git@github.com:lamontacrook/headless-first.git
-
Cambie al directorio
headless-first
e instale las dependencias.$ cd headless-first $ npm ci
Configuración de la aplicación React
-
Cree un archivo con el nombre
.env
en la raíz del proyecto. En.env
establezca los siguientes valores:REACT_APP_AEM=<URL of the AEM instance> REACT_APP_ENDPOINT=<the name of the endpoint> REACT_APP_PROJECT=<the name of the folder with Content Fragments> REACT_APP_TOKEN=<developer token>
-
Puede recuperar un token de desarrollador en Cloud Manager. Inicie sesión en Adobe Cloud Manager. Haga clic en Experience Manager > Cloud Manager. Elija el Programa adecuado y, a continuación, haga clic en los puntos suspensivos junto al Entorno.
- Haga clic en la ficha Integraciones
- Haga clic en la ficha Token local y obtenga el token de desarrollo local
- Copie el token de acceso comenzando después de la comillas abiertas hasta antes de la comillas de cierre.
- Pegue el token copiado como el valor de
REACT_APP_TOKEN
en el archivo.env
. - Ahora vamos a crear la aplicación ejecutando
npm ci
en la línea de comandos. - Ahora inicie la aplicación React y ejecute
npm run start
en la línea de comandos. - En ./src/utils un archivo de nombre
context.js
incluye el código para establecer los valores del archivo.env
en el contexto de la aplicación.
Ejecute la aplicación React
-
Inicie la aplicación React ejecutando
npm run start
en la línea de comandos.$ npm run start
La aplicación React se iniciará y abrirá una ventana del explorador a
http://localhost:3000
. Los cambios en la aplicación React se volverán a cargar automáticamente en el navegador.
Conexión a las API de AEM sin encabezado
-
Para conectar la aplicación React a AEM as a Cloud Service, vamos a agregar algunas cosas a
App.js
. En la importaciónReact
, agregueuseContext
.import React, {useContext} from 'react';
Importar
AppContext
desde el archivocontext.js
.import { AppContext } from './utils/context';
Ahora, en el código de la aplicación, defina una variable de contexto.
const context = useContext(AppContext);
Y finalmente ajuste el código de retorno en
<AppContext.Provider> ... </AppContext.Provider>
.... return(<div className='App'> <AppContext.Provider value={context}> ... </AppContext.Provider> </div>);
Como referencia,
App.js
debería ser así.import React, {useContext} from 'react'; import './App.css'; import { BrowserRouter, Routes, Route } from 'react-router-dom'; import Home from './screens/home/home'; import { AppContext } from './utils/context'; const App = () => { const context = useContext(AppContext); return ( <div className='App'> <AppContext.Provider value={context}> <BrowserRouter> <Routes> <Route exact={true} path={'/'} element={<Home />} /> </Routes> </BrowserRouter> </AppContext.Provider> </div> ); }; export default App;
-
Importe el SDK
AEMHeadless
. Esta SDK es una biblioteca de ayuda que la aplicación utiliza para interactuar con las API sin encabezado de AEM.Agregar esta instrucción de importación a
home.js
.import AEMHeadless from '@adobe/aem-headless-client-js';
Agregue el(la) siguiente
{ useContext, useEffect, useState }
a la instrucción de importaciónReact
.import React, { useContext, useEffect, useState } from 'react';
Importar
AppContext
.import { AppContext } from '../../utils/context';
Dentro del componente
Home
, obtenga la variablecontext
deAppContext
.const Home = () => { const context = useContext(AppContext); ... }
-
Inicialice el SDK sin encabezado de AEM dentro de
useEffect()
, ya que el SDK sin encabezado de AEM debe cambiar cuando cambie la variablecontext
.useEffect(() => { const sdk = new AEMHeadless({ serviceURL: context.url, endpoint: context.endpoint, auth: context.token }); }, [context]);
NOTE
Hay un archivocontext.js
en/utils
que está leyendo elementos del archivo.env
. Como referencia,context.url
es la dirección URL del entorno de AEM as a Cloud Service.context.endpoint
es la ruta de acceso completa al extremo creado en la lección anterior. Por último,context.token
es el token de desarrollador. -
Cree el estado React que expone el contenido proveniente de AEM Headless SDK.
const Home = () => { const [content, setContent] = useState({}); ... }
-
Conecte la aplicación a AEM. Utilice la consulta persistente creada en la lección anterior. Vamos a agregar el siguiente código dentro de
useEffect
después de inicializar AEM Headless SDK. Haga queuseEffect
dependa de la variablecontext
tal como se ve a continuación.useEffect(() => { ... sdk.runPersistedQuery('<name of the endpoint>/<name of the persisted query>', { path: `/content/dam/${context.project}/<name of the teaser fragment>` }) .then(({ data }) => { if (data) { setContent(data); } }) .catch((error) => { console.log(`Error with pure-headless/teaser. ${error.message}`); }); }, [context]);
-
Abra la vista Red de las herramientas del desarrollador para revisar la solicitud de GraphQL.
<url to environment>/graphql/execute.json/pure-headless/teaser%3Bpath%3D%2Fcontent%2Fdam%2Fpure-headless%2Fhero
AEM Headless SDK codifica la solicitud de GraphQL y agrega los parámetros proporcionados. Puede abrir la solicitud en el explorador.
NOTE
Dado que la solicitud va al entorno de creación, debe iniciar sesión en el entorno en otra pestaña del mismo explorador.
Procesar contenido de fragmentos de contenido
-
Muestre los fragmentos de contenido en la aplicación. Devuelve un(a)
<div>
con el título del teaser.return ( <div className='main-body'> <div>{content.component && (content.component.item.title)}</div> </div> );
Debería ver el campo de título del teaser en la pantalla.
-
El último paso es añadir el teaser a la página. Se incluye un componente de teaser de React en el paquete. En primer lugar, vamos a incluir la importación. En la parte superior del archivo
home.js
, agregue la línea:import Teaser from '../../components/teaser/teaser';
Actualice la instrucción return:
return ( <div className='main-body'> <div>{content.component && <Teaser content={content.component.item} />}</div> </div> );
Ahora debería ver el teaser con el contenido incluido en el fragmento.
Siguientes pasos
¡Enhorabuena! ¡Ha actualizado correctamente la aplicación React para integrarla con las API de AEM sin encabezado mediante el SDK sin encabezado de AEM!
A continuación, vamos a crear un componente de lista de imágenes más complejo que procese dinámicamente los fragmentos de contenido referenciados de AEM.
Capítulo siguiente: Creación de un componente de lista de imágenes