Passer au contenu principal

REST - Services Web

Introduction​

Les requêtes REST sont des adresses en ligne qui retournent des informations sur des données traitées sur le serveur, lequel contient la logique métier des données qui exigent sécurité et fiabilité, avec intégration de la base de données.

Plus d'informations sur REST

La construction de l'API REST est basée sur les Services de Netuno.

ALL​

Pour créer un service dans Netuno qui répond à tout type de méthode HTTP :

  • 📂 server/services/mon-service.js

Dans le navigateur, ce service sera exécuté pour tous les types de requêtes à l'adresse :

GET​

Les adresses de type GET sont normalement utilisées pour des opérations de listage ou d'obtention de données.

Pour créer un service dans Netuno qui répond uniquement au type de méthode GET, utilisez l'une de ces formes :

  • 📂 server/services/liste/get.js
  • 📂 server/services/liste.get.js

Dans le navigateur, ce service sera exécuté uniquement pour le type de requête GET à l'adresse :

POST​

Les adresses de type POST sont normalement utilisées pour des opérations qui créent ou génèrent de nouvelles données.

Pour créer un service dans Netuno qui répond uniquement au type de méthode POST, créez le fichier de code en utilisant l'une de ces formes :

  • 📂 server/services/creer/post.js
  • 📂 server/services/creer.post.js

Ce service sera exécuté uniquement pour le type de requête POST à l'adresse :

PUT​

Les adresses de type PUT sont normalement utilisées pour des opérations qui modifient des enregistrements de données.

Pour créer un service dans Netuno qui répond uniquement au type de méthode PUT, créez le fichier de code en utilisant l'une de ces formes :

  • 📂 server/services/enregistrer/put.js
  • 📂 server/services/enregistrer.put.js

Ce service sera exécuté uniquement pour le type de requête PUT à l'adresse :

DELETE​

Les adresses de type DELETE sont normalement utilisées pour des opérations qui suppriment de nouveaux enregistrements de données.

Pour créer un service dans Netuno qui répond uniquement au type de méthode DELETE, créez le fichier de code en utilisant l'une de ces formes :

  • 📂 server/services/supprimer/delete.js
  • 📂 server/services/supprimer.delete.js

Ce service sera exécuté uniquement pour le type de requête DELETE à l'adresse :

OPTIONS​

Lors de l'intégration avec le frontend, pendant le processus de validation du CORS, le navigateur effectue un appel de type OPTIONS.

Plus d'informations sur CORS.

Pour créer un service dans Netuno qui répond uniquement au type de méthode OPTIONS, créez le fichier de code en utilisant l'une de ces formes :

  • 📂 server/services/lister/options.js
  • 📂 server/services/lister.options.js

Doit être implémenté pour tous les services qui sont intégrés dans un frontend externe, comme un site web.

Code normalement utilisé :

_out.json(_val.map().set("resultat", true))

Ce service sera exécuté pour le type de requête OPTIONS à l'adresse :

Clients et exécution de tests​

Pour exécuter des tests sur les services avec le type de méthode spécifique, vous pouvez utiliser des programmes dédiés qui réalisent des tests sur API REST, comme :

CURL​

Avec la commande curl dans le terminal, vous pouvez effectuer tout type de test.

À partir de la console/ligne de commandes, envoyez un GET :

curl http://localhost:9000/services/enregistrer

Avec -X, vous pouvez spécifier le type de méthode :

curl -X POST -F 'nom=Test' -F 'email=email@exemple.com' http://localhost:9000/services/enregistrer

Le paramètre -F envoie avec le Content-Type : multipart/form-data

Une autre façon d'envoyer des paramètres :

curl -X POST -d 'nom=Test' -d 'email=email@exemple.com' http://localhost:9000/services/enregistrer

Peut être concaténé de la manière suivante :

curl -X POST -d 'nom=Test&email=email@exemple.com' http://localhost:9000/services/enregistrer

Le paramètre -d envoie avec le Content-Type : application/x-www-form-urlencoded

JSON​

Pour envoyer au format JSON, il est nécessaire de spécifier le type de contenu :

curl -X POST -H "Content-Type: application/json" \
    -d '{"nom": "Test", "email": "email@exemple.com"}' \
    http://localhost:9000/services/enregistrer

Le -H définit la paramétrisation de l'en-tête (HEADER)

Téléversement​

Pour effectuer le téléversement de fichiers :

curl -X POST -F 'image=@/home/utilisateur/fichier.jpg' http://localhost:9000/services/enregistrer

Client de service - NPM​

Pour faciliter l'intégration avec le frontend, le module NPM suivant est disponible :

Commande d'installation : npm i -S @netuno/service-client

En définissant l'adresse des services, comme :

_service.config({
    prefix: 'http://localhost:9000/services/'
});

Vous pourrez exécuter des services intégrés avec le frontend, par exemple :

  _service({
      url: "/services/mon-service",
      method: 'POST',
      data: { param1: "1", param2: "2" },
      success: (response) => {
          if (response.json) {
              console.log("Réponse du service", response.json);
          }
      },
      fail: (e) => {
          console.log("Erreur du service", e);
      }
  });

Conclusion​

Il est possible de restreindre les services uniquement au type de méthode HTTP souhaité.

Pour intégrer avec le frontend, cela peut être fait au plus bas niveau en utilisant fetch.

Pour accélérer et standardiser l'implémentation, le module NPM @netuno/service-client est disponible.