💙GET : Content

Nom de l'API : /content (GET)

Description : Cette API GET permet de récupérer tous les enregistrements de contenu textuel (content_strings) ainsi que la structure de l'application (app_structure). Elle est conçue pour fournir les données nécessaires à l'affichage du contenu dynamique et à la structure de navigation de l'application.

Endpoint : /content

Méthode : GET

Paramètres d'entrée :

  • slug (type: text, optionnel) : Permet de filtrer le contenu par un slug spécifique.

Fonctionnement :

  1. Query All Records From content_strings :

    • Récupère tous les enregistrements de la table content_strings.

    • Filtre appliqué : input:slug == db:content_strings.slug OR db:content_strings.global == true

    • Retourne le résultat sous le nom "content_strings".

  2. Query All Records From app_structure :

    • Récupère tous les enregistrements de la table app_structure.

    • Aucun filtre n'est appliqué.

    • Retourne le résultat sous le nom "app_structure".

  3. Create Variable (response) :

    • Crée un objet "response" contenant deux propriétés : a. strings : contient les données de content_strings b. structure : contient les données de app_structure

Réponse : L'API renvoie l'objet "response" au format JSON, qui inclut :

  • strings : Un tableau d'objets représentant le contenu textuel filtré ou global.

  • structure : Un tableau d'objets représentant la structure de l'application.

Utilisation : Cette API est utilisée pour charger le contenu textuel et la structure de l'application. Elle permet de :

  1. Récupérer le contenu spécifique à une page en utilisant le paramètre "slug".

  2. Obtenir tout le contenu global de l'application.

  3. Charger la structure complète de l'application pour la navigation et l'organisation des pages.

Exemple d'utilisation : GET /content?slug=home-page

Cela récupérera le contenu spécifique à la page d'accueil ainsi que tout le contenu global et la structure complète de l'application.

Notes pour les développeurs :

  • Assurez-vous que la table content_strings contient bien les champs "slug" et "global".

  • La structure de l'application (app_structure) est toujours renvoyée en entier, ce qui peut nécessiter une gestion côté client pour les grandes applications.

  • Cette API est conçue pour être efficace en minimisant le nombre d'appels nécessaires pour charger le contenu d'une page.

Dernière mise à jour