Tester votre API REST avec l'extension Rest Client

Installer l'extension Rest Client dans Visual Studio Code

Ce fichier request.rest est utilisé pour tester les requêtes HTTP vers une API REST. Il est particulièrement utile lorsque vous utilisez des outils comme l'extension REST Client dans Visual Studio Code. Voici une explication détaillée de chaque partie du fichier :

Définition de la variable de base

• @baseUrl : Cette ligne définit une variable nommée baseUrl qui contient l'URL de base de votre API. Cela vous permet de spécifier l'URL de base une seule fois et de la réutiliser dans toutes les requêtes suivantes. Si l'URL de votre API change, vous n'aurez besoin de la mettre à jour qu'à cet endroit.

Récupérer tous les aliments

• ### Récupérer tous les aliments : C'est un commentaire qui décrit ce que fait la requête suivante. Les commentaires dans un fichier request.rest sont utiles pour documenter ce que chaque requête est censée accomplir.

• GET {{baseUrl}}/foods : Cette ligne envoie une requête HTTP GET à l'URL /foods de votre API. La syntaxe {{baseUrl}} est remplacée par la valeur de @baseUrl définie précédemment. Cette requête est utilisée pour récupérer tous les aliments de la base de données.

Récupérer un aliment spécifique par ID

• ### Récupérer un aliment spécifique par ID : Commentaire décrivant la requête suivante.

• GET {{baseUrl}}/foods/1 : Cette ligne envoie une requête HTTP GET à l'URL /foods/1, où 1 est l'ID de l'aliment que vous souhaitez récupérer. Cette requête est utilisée pour obtenir les détails d'un aliment spécifique.

Créer un nouvel aliment

• ### Créer un nouvel aliment : Commentaire décrivant la requête suivante.

• POST {{baseUrl}}/foods : Cette ligne envoie une requête HTTP POST à l'URL /foods. Les requêtes POST sont utilisées pour envoyer des données au serveur, généralement pour créer une nouvelle ressource.

• Content-Type: application/json : Cette ligne définit l'en-tête Content-Type de la requête, indiquant que le corps de la requête est au format JSON.

• Corps de la requête : Le bloc JSON suivant est le corps de la requête, contenant les données du nouvel aliment à créer. Il inclut le nom, le type et l'emoji de l'aliment.

Mettre à jour un aliment existant

• ### Mettre à jour un aliment existant : Commentaire décrivant la requête suivante.

• PUT {{baseUrl}}/foods/1 : Cette ligne envoie une requête HTTP PUT à l'URL /foods/1. Les requêtes PUT sont utilisées pour mettre à jour une ressource existante sur le serveur.

• Content-Type: application/json : Définit l'en-tête Content-Type de la requête.

• Corps de la requête : Le bloc JSON suivant est le corps de la requête, contenant les données mises à jour de l'aliment avec l'ID 1.

Supprimer un aliment

• ### Supprimer un aliment : Commentaire décrivant la requête suivante.

• DELETE {{baseUrl}}/foods/1 : Cette ligne envoie une requête HTTP DELETE à l'URL /foods/1. Les requêtes DELETE sont utilisées pour supprimer une ressource spécifique du serveur.

Utilisation

Pour utiliser ce fichier request.rest :

1. Installer l'extension REST Client : Si vous utilisez Visual Studio Code, installez l'extension REST Client depuis le marketplace des extensions.

2. Créer le fichier request.rest : Créez un fichier nommé request.rest dans votre projet et copiez-y le contenu ci-dessus.

3. Envoyer les requêtes : Ouvrez le fichier request.rest dans Visual Studio Code. Vous verrez des liens "Send Request" au-dessus de chaque requête. Cliquez sur ces liens pour envoyer les requêtes et voir les réponses directement dans l'éditeur.

En utilisant ce fichier, vous pouvez facilement tester les différentes fonctionnalités de votre API REST sans avoir besoin d'un outil externe comme Postman.

@baseUrl = http://localhost/Food/back/

### Récupérer tous les aliments
GET {{baseUrl}}/foods

### Récupérer un aliment spécifique par ID
GET {{baseUrl}}/foods/1

### Créer un nouvel aliment
POST {{baseUrl}}/foods
Content-Type: application/json

{
    "name": "Avocat",
    "type": "fruit",
    "emoji": "🥑"
}

### Mettre à jour un aliment existant
PUT {{baseUrl}}/foods/1
Content-Type: application/json

{
    "name": "Avocat Mise à Jour",
    "type": "fruit",
    "emoji": "🥑"
}

### Supprimer un aliment
DELETE {{baseUrl}}/foods/1