Skip to main content

API Layer

Ce guide vous expliquera comment utiliser la fonction Layer pour créer des couches d'API modulaires dans votre application. Une couche vous permet de structurer les interactions avec votre API de manière claire et organisée.

Qu'est-ce qu'une couche ?​

Une couche est une abstraction qui facilite la gestion des interactions avec votre API. Elle encapsule les détails de l'implémentation et expose des méthodes pour interagir avec les données. Avec cette approche, vous pouvez facilement ajouter des fonctionnalités supplémentaires et organiser votre code.

Création d'une couche​

Pour créer une nouvelle couche, vous utiliserez la fonction Layer. Cette fonction prend en paramètre une URL de base et retourne un constructeur de couche.

Étapes pour créer une couche :​

  1. Importez la fonction Layer depuis votre module API.
  2. Appelez la fonction Layer avec une URL de base pour créer votre couche.
  3. Définissez les méthodes pour les opérations que vous souhaitez effectuer (comme get, update, et delete).

Exemple de création d'une couche :​

Voici un exemple de création d'une couche pour gérer les sessions :

import { Layer } from 'api-layer';

const SessionClient = Layer(new URL("/sessions"))({
  get() {
    // Implémentation pour récupérer une session
  },
  update(data) {
    // Implémentation pour mettre à jour une session
  },
  delete() {
    // Implémentation pour supprimer une session
  }
});

Utiliser une couche​

Une fois votre couche créée, vous pouvez l'utiliser pour effectuer des opérations sur votre API.

Récupérer une session​

Pour récupérer les détails d'une session :

const sessionId = '12345';
const sessionDetails = await SessionClient( sessionId ).get();
console.log(sessionDetails);

Mettre à jour une session​

Pour mettre à jour une session, passez l'identifiant de la session et les nouvelles données :

await SessionClient( "sessionId" ).update({ /* nouvelles données */ });

Supprimer une session​

Pour supprimer une session, utilisez l'identifiant correspondant :

await SessionClient( "sessionId" ).delete();

Ajouter des sous-couches​

Vous pouvez également ajouter des sous-couches à votre couche principale. Par exemple, si vous souhaitez intégrer un ProjectClient dans votre SessionLayer, vous pouvez le faire comme suit :

import { ProjectClient } from '../project';

SessionClient.use('Project', ProjectClient);

Cela vous permettra d'accéder aux fonctionnalités du ProjectClient directement à partir de votre SessionLayer.

await SessionClient( "sessionId" ).Project( "projectId" ).get();

Conclusion​

L'utilisation de la fonction Layer vous permet de créer des couches d'API modulaires et réutilisables, ce qui facilite la gestion des interactions avec votre API. En organisant votre code de cette manière, vous pouvez améliorer la lisibilité et la maintenabilité de votre application.