Introduction à LightREST

Le composant LightREST contient toutes les fonctions et constantes nécessaires pour faciliter le développement de Web Services REST sous WinDev^®.

Il met à disposition du développeur plusieurs classes, dont tous les éléments sont documentés :

• Les Classes lrServer, lrRoute, lrRequest, lrResponse, lrHook, lrSession.
• Les Constantes Method : Méthodes REST (GET, POST, …)
• Les Constantes Content : Type MIME du contenu de la réponse (application/json, text/plain, …)
• Les Constantes Status : Statut d’exécution (200=OK, 401=Non autorisé, …)

Nul besoin de connaître les codes des statuts ou des types MIME par coeur, les constantes LightREST sont là pour les renseigner à votre place.

L’implémentation d’un serveur REST avec LightREST se fait simplement :

• Détermination des API à déployer : Pour chaque API, une route est définir (=une URL + une méthode). Chaque Route est rattachée à une procédure WinDev^® qui sera exécutée par LightREST lorsqu’une URL correspondant à la Route sera appelée. Pour une meilleure lisibilité, cette procédure WinDev^® sera appelée Handler dans cette documentation.
• Implémentation des Handlers REST : Pour chaque Route+Méthode, le handler reçoit les objets lrRequest (contenant la requête REST reçue) et lrResponse (contenant la réponse à envoyer au client REST). NB : Jusqu’à la version 2.8, le handler reçoit un objet lrRequest et doit retourner un résultat de type lrResponse.

Pour bien débuter, consultez le Guide démarrage rapide.