{"id":161,"date":"2023-08-23T17:46:46","date_gmt":"2023-08-23T15:46:46","guid":{"rendered":"http:\/\/127.0.0.1\/wordpress\/index.php\/docs\/"},"modified":"2026-03-13T17:10:12","modified_gmt":"2026-03-13T15:10:12","slug":"lightrest-documentation","status":"publish","type":"page","link":"https:\/\/lightrest.codeline.fr\/index.php\/lightrest-composant-rest-windev\/lightrest-documentation\/","title":{"rendered":"Introduction \u00e0 LightREST"},"content":{"rendered":"\n<h4 class=\"wp-block-heading\">Introduction \u00e0 <strong>LightREST<\/strong><\/h4>\n\n\n\n<p class=\"has-text-color\" style=\"color:#004080\">Le composant <strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#004080\" class=\"has-inline-color\">LightREST<\/mark> <\/strong>contient toutes les fonctions et constantes n\u00e9cessaires pour faciliter le d\u00e9veloppement de Web Services REST sous <a href=\"https:\/\/pcsoft.fr\/windev\/\" target=\"_blank\" rel=\"noreferrer noopener\">WinDev<sup>\u00ae<\/sup><\/a>.<\/p>\n\n\n\n<p>Il met \u00e0 disposition du d\u00e9veloppeur plusieurs classes, dont tous les \u00e9l\u00e9ments sont document\u00e9s :<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Les Classes <strong><u><a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrserver\/\" data-type=\"page\" data-id=\"2275\">lrServer<\/a><\/u><\/strong>, <strong><u><a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrroute\/\" data-type=\"page\" data-id=\"2284\">lrRoute<\/a><\/u><\/strong>, <strong><u><a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrrequest\/\" data-type=\"page\" data-id=\"2277\">lrRequest<\/a><\/u><\/strong>, <strong><u><a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrresponse\/\" data-type=\"page\" data-id=\"2282\">lrResponse<\/a><\/u><\/strong>, <strong><a href=\"\/index.php\/la-classe-lrhook\/\" data-type=\"page\" data-id=\"2374\"><u>lrHook<\/u><\/a><\/strong>, <strong><u><a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrsession\/\" data-type=\"page\" data-id=\"2286\">lrSession<\/a><\/u><\/strong>.<\/li>\n\n\n\n<li>Les Constantes <strong><u>Method<\/u><\/strong> : M\u00e9thodes REST (<em>GET<\/em>, <em>POST<\/em>, &#8230;)<\/li>\n\n\n\n<li>Les Constantes <strong><u>Content<\/u> <\/strong>: Type MIME du contenu de la r\u00e9ponse (<em>application\/json<\/em>, <em>text\/plain<\/em>, &#8230;)<\/li>\n\n\n\n<li>Les Constantes <strong><u>Status<\/u><\/strong> : Statut d&rsquo;ex\u00e9cution (<em>200=OK<\/em>, <em>401=Non autoris\u00e9<\/em>, &#8230;)<\/li>\n<\/ul>\n\n\n\n<p>Nul besoin de conna\u00eetre les codes des statuts ou des types MIME par coeur, les constantes <strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#004080\" class=\"has-inline-color\">LightREST<\/mark> <\/strong>sont l\u00e0 pour les renseigner \u00e0 votre place.<\/p>\n\n\n\n<p>L&rsquo;impl\u00e9mentation d&rsquo;un serveur REST avec <strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#004080\" class=\"has-inline-color\">LightREST<\/mark> <\/strong>se fait simplement :<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>D\u00e9termination des API \u00e0 d\u00e9ployer <\/strong>: Pour chaque API, une route est d\u00e9finir (=une URL + une m\u00e9thode). Chaque Route est rattach\u00e9e \u00e0 une proc\u00e9dure <a href=\"https:\/\/pcsoft.fr\/windev\/\" target=\"_blank\" rel=\"noreferrer noopener\">WinDev<sup>\u00ae<\/sup><\/a> qui sera ex\u00e9cut\u00e9e par <strong><mark style=\"background-color:rgba(0, 0, 0, 0);color:#004080\" class=\"has-inline-color\">LightREST<\/mark> <\/strong>lorsqu&rsquo;une URL correspondant \u00e0 la Route sera appel\u00e9e. Pour une meilleure lisibilit\u00e9, cette proc\u00e9dure <a href=\"https:\/\/pcsoft.fr\/windev\/\" target=\"_blank\" rel=\"noreferrer noopener\">WinDev<sup>\u00ae<\/sup><\/a> sera appel\u00e9e <em>Handler <\/em>dans cette documentation.<\/li>\n\n\n\n<li><strong>Impl\u00e9mentation des Handlers REST<\/strong> : Pour chaque Route+M\u00e9thode, le handler re\u00e7oit les objets <a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrrequest\/\" title=\"LightREST : La classe lrRequest\"><strong><em>lrRequest<\/em> <\/strong><\/a> (contenant la requ\u00eate REST re\u00e7ue) et <a href=\"https:\/\/lightrest.codeline.fr\/index.php\/lightrest-composant-rest-windev\/lightrest-documentation\/la-classe-lrresponse\/\" title=\"LightREST : La classe lrResponse\"><strong><em>lrResponse<\/em><\/strong><\/a> (contenant la r\u00e9ponse \u00e0 envoyer au client REST). <em>NB : Jusqu&rsquo;\u00e0 la version 2.8, le handler re\u00e7oit un objet <a href=\"https:\/\/lightrest.codeline.fr\/index.php\/la-classe-lrrequest\/\" title=\"LightREST : La classe lrRequest\"><strong>lrRequest <\/strong><\/a>et doit retourner un r\u00e9sultat de type <a href=\"https:\/\/lightrest.codeline.fr\/index.php\/lightrest-composant-rest-windev\/lightrest-documentation\/la-classe-lrresponse\/\" title=\"LightREST : La classe lrResponse\"><strong>lrResponse<\/strong><\/a>.<\/em><\/li>\n<\/ul>\n\n\n\n<p>Pour bien d\u00e9buter, consultez le <a href=\"\/demarrage-rapide\" title=\"\"><u>Guide d\u00e9marrage rapide<\/u><\/a>.<\/p>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Introduction \u00e0 LightREST Le composant LightREST contient toutes les fonctions et constantes n\u00e9cessaires pour faciliter le d\u00e9veloppement de Web Services REST sous WinDev\u00ae. Il met \u00e0 disposition du d\u00e9veloppeur plusieurs classes, dont tous les \u00e9l\u00e9ments sont document\u00e9s : Nul besoin de conna\u00eetre les codes des statuts ou des types MIME par coeur, les constantes LightREST [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":182,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-161","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/pages\/161","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/comments?post=161"}],"version-history":[{"count":74,"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/pages\/161\/revisions"}],"predecessor-version":[{"id":2646,"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/pages\/161\/revisions\/2646"}],"up":[{"embeddable":true,"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/pages\/182"}],"wp:attachment":[{"href":"https:\/\/lightrest.codeline.fr\/index.php\/wp-json\/wp\/v2\/media?parent=161"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}