Strapi & Astro
Strapi est un CMS headless open-source et personnalisable.
Intégration avec Astro
Section intitulée « Intégration avec Astro »Ce guide va créer une fonction wrapper pour connecter Strapi avec Astro.
Prérequis
Section intitulée « Prérequis »Pour commencer, vous devez disposer des éléments suivants :
- Un projet Astro - Si vous n’avez pas encore de projet Astro, notre guide d’installation vous permettra d’être opérationnel en un rien de temps.
- Un serveur CMS Strapi - Vous pouvez configurer un serveur Strapi dans un environnement local.
Ajouter l’URL de Strapi dans .env
Section intitulée « Ajouter l’URL de Strapi dans .env »Pour ajouter votre URL Strapi à Astro, créez un fichier .env à la racine de votre projet (s’il n’existe pas déjà) et ajoutez la variable suivante :
STRAPI_URL="http://127.0.0.1:1337" # ou utilisez votre adresse IPVous pouvez maintenant utiliser cette variable d’environnement dans votre projet Astro.
Si vous voulez avoir IntelliSense pour votre variable d’environnement, vous pouvez créer un fichier env.d.ts dans le répertoire src/ et configurer ImportMetaEnv comme ceci :
interface ImportMetaEnv { readonly STRAPI_URL: string;}Votre répertoire racine devrait maintenant contenir le(s) nouveau(x) fichier(s) :
Répertoiresrc/
- env.d.ts
- .env
- astro.config.mjs
- package.json
.env dans Astro.
Création du wrapper de l’API
Section intitulée « Création du wrapper de l’API »Créez un nouveau fichier src/lib/strapi.ts et ajoutez la fonction wrapper suivante pour interagir avec l’API Strapi :
interface Props { endpoint: string; query?: Record<string, string>; wrappedByKey?: string; wrappedByList?: boolean;}
/** * Récupère les données de l'API Strapi * @param endpoint - Le point d'accès à partir duquel la recherche doit être effectuée * @param query - Les paramètres de requête à ajouter à l'URL * @param wrappedByKey - La clé pour désenvelopper la réponse * @param wrappedByList - Si la réponse est une liste, la désenvelopper. * @returns */export default async function fetchApi<T>({ endpoint, query, wrappedByKey, wrappedByList,}: Props): Promise<T> { if (endpoint.startsWith('/')) { endpoint = endpoint.slice(1); }
const url = new URL(`${import.meta.env.STRAPI_URL}/api/${endpoint}`);
if (query) { Object.entries(query).forEach(([key, value]) => { url.searchParams.append(key, value); }); } const res = await fetch(url.toString()); let data = await res.json();
if (wrappedByKey) { data = data[wrappedByKey]; }
if (wrappedByList) { data = data[0]; }
return data as T;}Cette fonction nécessite un objet ayant les propriétés suivantes :
endpoint- Le point de terminaison que vous interrogez.query- Les paramètres de requête à ajouter à la fin de l’URLwrappedByKey- La clédatadans l’objet qui enveloppe votreResponse.wrappedByList- Un paramètre pour « désenvelopper » la liste retournée par Strapi, et ne retourner que le premier élément.
Facultatif : Création de l’interface Article
Section intitulée « Facultatif : Création de l’interface Article »Si vous utilisez TypeScript, créez l’interface Article suivante pour correspondre aux types de contenu de Strapi dans src/interfaces/article.ts :
export default interface Article { documentId: number; title: string; description: string; content: string; slug: string; createdAt: string; updatedAt: string; publishedAt: string; image: { data: { url: string; }; };}Vous pouvez modifier cette interface, ou en créer plusieurs, pour qu’elle corresponde à vos propres données de projet.
Répertoiresrc/
Répertoireinterfaces/
- article.ts
Répertoirelib/
- strapi.ts
- env.d.ts
- .env
- astro.config.mjs
- package.json
Affichage d’une liste d’articles
Section intitulée « Affichage d’une liste d’articles »-
Mettez à jour votre page d’accueil
src/pages/index.astropour afficher une liste d’articles de blog, chacun avec une description et un lien vers sa propre page. -
Importez la fonction wrapper et l’interface. Ajoutez l’appel API suivant pour récupérer vos articles et renvoyer une liste :
src/pages/index.astro ---import fetchApi from '../lib/strapi';import type Article from '../interfaces/article';const articles = await fetchApi<Article[]>({endpoint: 'articles', // le type de contenu à récupérerwrappedByKey: 'data', // la clé pour désenvelopper la réponse});---L’appel API demande des données à
http://localhost:1337/api/articleset renvoiearticles: un tableau d’objets json représentant vos données :[{documentId: 1,title: "Qu'y a-t-il à l'intérieur d'un trou noir",description: "La réponse est peut-être dans cet article, ou pas...",content: "Eh bien, nous ne le savons pas encore...",slug: "qu-y-a-t-il-a-l'interieur-d-un-trou-noir",createdAt: "2023-05-28T13:19:46.421Z",updatedAt: "2023-05-28T13:19:46.421Z",publishedAt: "2023-05-28T13:19:45.826Z"},// ...] -
En utilisant les données du tableau
articlesrenvoyé par l’API, affichez les articles de votre blog Strapi dans une liste. Ces articles seront liés à leur propre page individuelle, que vous allez créer à l’étape suivante.src/pages/index.astro ---import fetchApi from '../lib/strapi';import type Article from '../interfaces/article';const articles = await fetchApi<Article[]>({endpoint: 'articles?populate=image',wrappedByKey: 'data',});---<!DOCTYPE html><html lang="fr"><head><title>Strapi & Astro</title></head><body><main><ul>{articles.map((article) => (<li><a href={`/blog/${article.slug}/`}>{article.title}</a></li>))}</ul></main></body></html>