• lors de la création d'une nouvelle description de Webservices REST.
• sous le volet "Webservice REST", dans le groupe "Points d'entrée", en cliquant sur "Nouveau".
  
  
  Remarque : Le volet "Webservice REST" est disponible uniquement lorsqu'une description de Webservice REST est affichée sous l'éditeur.

• Méthode 1 : Création manuelle des points d'entrée.
• Méthode 2 : Création automatique des points d'entrée à partir de la description d'un fichier de données (présent dans l'analyse).
• Méthode 3 : Création automatique des points d'entrée depuis les procédures d'une collection.

1. Dans l'assistant, sélectionnez l'option "Créer un point d'entrée".
2. Passez à l'étape suivante.
3. Spécifiez la procédure globale WLangage associée au point d'entrée. Cette procédure peut être créée ou être sélectionnée parmi les procédures globales existantes.
   
4. Passez à l'étape suivante.
5. Choisissez la méthode HTTP représentant l'action à réaliser (GET, PUT, ...).
   
6. Passez à l'étape suivante.
7. Définissez la ressource (ou partie d'URL) correspondant au point d'entrée. Cette ressource peut comporter des éléments statiques ou des éléments variables (paramètres).
   
   Pour plus de détails sur la ressource, consultez le paragraphe Composition de la ressource.
8. Passez à l'étape suivante.
9. Définissez le format de la requête et le format de la réponse. Le standard en REST est JSON mais d'autres formats sont disponibles.
   • Le format de la requête indique comment sont formatés les données passées lors de l'appel REST.
     
     Ce format peut être sous la forme :
     • Formulaire HTML,
     • JSON,
     • XML,
     • Texte (type MIME "Text/Plain"),
     • Binaire (pour des images par exemple),
     • Variable (le format est libre et doit être indiqué par programmation par la fonction WebserviceLitTypeMIME).
   • Désérialisation automatique : Dans le cas d'une action de type POST, PUT ou PATCH, il est possible de désérialiser automatiquement les données passées en paramètre de la requête dans un paramètre de la procédure associée au point d'entrée :
     
     • Cochez la case "Désérialiser automatiquement le contenu de la requête dans un paramètre de la procédure associée au point d'entrée.".
       Attention : si la procédure n'a pas de paramètre défini, cette case à cocher n'est pas active.
     • Sélectionnez dans la liste le nom du paramètre cible.
       Attention : Il est nécessaire que le code de la procédure gère le paramètre cible. Il est très important et obligatoire de typer le paramètre de la procédure. Les types de paramètres autorisés dans la procédure sont : buffer, chaîne Ansi, structure, tableau, objet. Les types simples (entier, date, heure, booléen, ...) ne sont pas autorisés.
       Pour plus de détails, consultez WebServices REST : Désérialisation automatique de la requête.
       Remarque : Si des modifications doivent être effectuées dans la procédure, il est possible de configurer la désérialisation automatique depuis la fenêtre de description du Webservice REST.
   • Le format de la réponse indique comment sont formatés les données récupérées en retour d'un appel REST.
     
     Ce format peut être sous la forme :
     • Aucun,
     • JSON,
     • XML,
     • Texte (type MIME "Text/Plain"),
     • Binaire (pour des images par exemple),
     • Variable (le format est libre et doit être indiqué par programmation par la fonction WebserviceEcritTypeMIME).
10. Passez à l'étape suivante.
11. Saisir la description du point d'entrée (texte libre).
12. Validez.

La description des différents points d'entrée est affichée sous l'éditeur.

1. Dans l'assistant, sélectionnez l'option "Créer les points d'entrée depuis les procédures d'une collection".
2. Sélectionnez dans la liste la collection de procédures ou la classe associée au point d'entrée.
   
3. Passez à l'étape suivante.
4. Sélectionnez les procédures et ou les méthodes qui seront exposées par le Webservice REST. La ressource associée à chaque procédure ou méthode sera automatiquement initialisée en fonction du nom de la procédure et de ses paramètres.
   
   
   Pour chaque procédure sélectionnée, précisez la méthode HTTP correspondante.
5. Passez à l'étape suivante.
6. Définissez le format de la requête et le format de la réponse. Le standard en REST est JSON mais d'autres formats sont disponibles.
   • Le format de la requête indique comment sont formatés les données passées lors de l'appel REST.
     
     Ce format peut être sous la forme :
     • Formulaire HTML,
     • JSON,
     • XML,
     • Texte (type MIME "Text/Plain"),
     • Binaire (pour des images par exemple),
     • Variable (le format est libre et doit être indiqué par programmation par la fonction WebserviceLitTypeMIME).
   • Le format de la réponse indique comment sont formatés les données récupérées en retour d'un appel REST. Ce format peut être sous la forme :
     • Aucun,
     • JSON,
     • XML,
     • Texte (type MIME "Text/Plain"),
     • Binaire (pour des images par exemple),
     • Variable (le format est libre et doit être indiqué par programmation par la fonction WebserviceEcritTypeMIME).
7. Terminez l'assistant.

La description des différents points d'entrée est affichée sous l'éditeur.

Composition de la ressource (ou partie d'URL)

• d'éléments statiques.
• d'éléments variables.
• de paramètres communs (optionnels).

• Dans l'assistant de création de l'URL, un élément variable correspond :
  • soit à une composante variable de type paramètre de procédure. Cette composante est récupérée automatiquement dans les paramètres de la procédure WLangage associée.
  • soit à une composante variable de type programmation, récupéré par programmation par la fonction WebserviceParamètre.
• Un élément variable est représenté par la syntaxe "{Nom composante variable}".
  Par exemple, "/Clients/10" permet de manipuler les clients ayant l'identifiant 10.
• Il est habituel de passer les éléments variables dans l'URL lors d'un appel à une fonction REST.
• Chaque composante variable de type programmation, dans la ressource (URL) du point d'entrée correspond à un paramètre passé à la procédure WLangage associée au point d'entrée.
• Un élément variable est représenté par un nom lors de la définition de l'adresse du point d'entrée dans l'éditeur. Dans le cas d'une composante variable de type programmation, ce nom doit être identique au nom du paramètre dans la procédure WLangage associé au point d'entrée.
  Au moment de l'exécution, la valeur passée dans la ressource (URL) sera récupérée et mise dans la variable. Ce nom est sensible à la casse. Il est donc très important d'utiliser le même nom dans la procédure et dans la ressource (ou inversement) sinon une erreur d'exécution est générée.

• "/Clients/{idClient}/Factures" pour récupérer les factures d'un client identifié par son idClient.
• "/Fournisseurs/{idFour}/Produits/{RefProd}" pour récupérer le produit identifié par "RefProd" du fournisseur identifié par "idFour".

Pour modifier les paramètres communs, sous le volet "Webservice REST", dans le groupe "Options", cliquez sur "Description".

Gestion des codes retour dans le code des procédures

• Les codes 2xx correspondent à une action réalisée avec succès.
• Les codes 3xx correspondent à des erreurs de redirection.
• Les codes 4xx correspondent à des erreurs du client (méthode HTTP incorrecte, format de donnée envoyé incorrect, etc.).
• Les codes 5xx correspondent à des erreurs du serveur (erreur interne à la procédure WLangage, etc).

• Demande de création d'un client via la méthode HTTP POST. Cette demande a réussi : il faut renvoyer le code 201.
• Demande de suppression d'un client via la méthode DELETE. Cette demande a échoué à cause d'une erreur d'intégrité retournée par la base de données : il faut renvoyer le code 500 avec un message complémentaire d'explication.
• Demande de recherche d'un produit en passant en paramètre une référence via la méthode GET. Cette demande a réussi : il faut renvoyer le code 200.
• Demande de recherche d'un produit en passant en paramètre une référence via la méthode GET. Cette demande a échoué car la référence est inexistante : il faut renvoyer le code 404.