Un Webservice REST est un programme hébergé sur un serveur contenant des fonctions accessibles via des requêtes HTTP. Chaque fonction (également appelée API ou point d'entrée) correspond à un traitement exécuté sur le serveur.

• une ressource,
• une méthode HTTP (verbe GET, POST, PUT, etc.).

• GET pour récupérer des informations.
• POST pour créer.
• PUT pour modifier.
• DELETE pour supprimer.
• PATCH pour modifier.
• HEAD pour récupérer des informations.

Principe de l'appel à une fonction d'un Webservice REST

L'appel à une fonction d'un Webservice REST est réalisé via une ressource (URL).

• serveur représente l'adresse du serveur hébergeant le Webservice REST.
• Clients indique des données concernant des clients sont manipulées.
• 10 représente l'identifiant du client à manipuler.
• Commandes indique des données concernant des commandes sont manipulées.

Cette requête HTTP est effectuée via la méthode GET : l'utilisation de cette méthode indique que des données doivent être récupérées en retour de l'appel.

Pour créer un Webservice REST :

1. Créez un projet ou une configuration de projet de type Webservice REST.
2. Créez une ou plusieurs descriptions de Webservice REST. Une description de Webservice REST permet de regrouper une liste de fonctions pour un même thème.
3. Dans chaque description, créez les points d'entrée nécessaires.
4. Définissez les options de chaque description :
   • Composante commune,
   • Procédure prologue,
   • Autorisation (cas d'un webservice sécurisé).
5. Générez si nécessaire la documentation OpenAPI.
6. Testez le Webservice REST.
7. Générez et déployez le Webservice REST.

Création d'un projet de type Webservice REST

Pour créer un projet de type Webservice REST :

1. Cliquez sur parmi les boutons d'accès rapide de WINDEV. La fenêtre de création d'un nouvel élément s'affiche : cliquez sur "Projet". L'assistant de création d'un projet se lance.
2. Choisissez le type de projet à créer, "Webservice SOAP ou REST". Passez à l'étape suivante de l'assistant.
3. Choisissez un Webservice de type REST. Passez à l'étape suivante.
4. Indiquez le nom du projet et son emplacement. Ces options ne seront pas modifiables.
   Tous les objets associés au projet seront créés dans le répertoire spécifié.
5. Terminez l'assistant. Le projet créé devient le projet en cours.

Création d'une configuration de projet de type Webservice REST

Pour créer une configuration de projet de type Webservice REST :

1. Dans le volet "Explorateur de projet", affichez le menu contextuel de l'option "Configurations" et sélectionnez "Nouvelle configuration". L'assistant de création d'une nouvelle configuration de projet se lance.
2. Sélectionnez une configuration "Webservice SOAP ou REST" et indiquez si nécessaire le nom et la description de la configuration de projet. Passez à l'étape suivante de l'assistant.
3. Choisissez de générer un Webservice REST. Passez à l'étape suivante de l'assistant.
4. Indiquez si nécessaire les éléments à intégrer dans la configuration de projet.
5. Terminez l'assistant. Une nouvelle description de Webservice REST est automatiquement créée et l'assistant de création d'un point d'entrée se lance.

Rappel : Une description d'un Webservice REST permet de regrouper une liste de fonctions pour un même thème.

1. Dans le volet "Explorateur de projet", sélectionnez "Descriptions de Webservices REST", puis dans le menu contextuel (clic droit), sélectionnez "Nouvelle description d'un Webservice REST".
   
2. Saisissez le nom de la description du Webservice REST, puis validez.
3. L'assistant de saisie d'un nouveau point d'entrée se lance automatiquement.

L'assistant de création d'un point d'entrée propose de sélectionner la méthode de création des points d'entrée :

• 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.