Extension Rest Client

L'extension REST Client pour Visual Studio Code permet aux développeurs de créer et d'exécuter des requêtes HTTP directement à partir de l'éditeur de code. Cela élimine le besoin d'utiliser des outils externes tels que Postman ou curl pour tester les API REST. Voici quelques-unes des fonctionnalités et des utilisations de l'extension REST Client :

1. Création de Requêtes HTTP :

  • Les utilisateurs peuvent écrire des requêtes HTTP dans un fichier .http ou .rest, en utilisant une syntaxe simple et claire.
  • Ils peuvent définir des méthodes HTTP (GET, POST, PUT, DELETE, etc.), des URL, des en-têtes, des corps de requête, et d'autres composants de la requête HTTP.

2. Exécution de Requêtes HTTP :

  • Les requêtes peuvent être exécutées directement à partir de l'éditeur en cliquant sur le lien "Send Request" qui apparaît au-dessus de la définition de la requête.
  • Les réponses HTTP sont affichées dans une fenêtre séparée, permettant aux utilisateurs de voir les codes de statut, les en-têtes de réponse, et les corps de réponse.

3. Gestion des Environnements :

  • L'extension permet de définir des variables d'environnement pour stocker des valeurs telles que les URL de base, les clés d'API, etc.
  • Les utilisateurs peuvent facilement basculer entre différents environnements, ce qui est utile pour tester les API dans des environnements de développement, de test, et de production.

4. Gestion des Cookies et Authentification :

  • L'extension gère automatiquement les cookies et supporte plusieurs mécanismes d'authentification, tels que Basic Auth et OAuth.
  • Les utilisateurs peuvent également personnaliser les requêtes avec des scripts pré-requête pour gérer l'authentification et d'autres besoins.

5. Organisation des Requêtes :

  • Les utilisateurs peuvent organiser les requêtes en collections et les partager avec d'autres membres de l'équipe.
  • Ils peuvent également commenter et documenter les requêtes pour une meilleure compréhension.

Conclusion :

L'extension REST Client de Visual Studio Code est un outil puissant et flexible qui simplifie le processus de test et de débogage des API REST pour les développeurs, en intégrant la création et l'exécution de requêtes HTTP directement dans l'environnement de développement.

 

RequestPersonnage.rest

# Récupérer tous les personnages
GET http://localhost:8080/personnages
Accept: application/json

###

# Récupérer un personnage par ID
GET http://localhost:8080/personnages/1
Accept: application/json


###

# Récupérer les objets d'un personnage
GET http://localhost:8080/personnages/1/inventaire/objets
Accept: application/json


###

# Créer un nouveau personnage
POST http://localhost:8080/personnages
Content-Type: application/json
Accept: application/json

{
  "nom": "Peter Doe",
  "classe": "Guerrier",
  "niveau": 1,
  "pointsExperience": 0,
  "pointsVie": 100,
  "pointsMana": 50,
  "pointsForce": 10,
  "pointsScore": 0
}

###

# Mettre à jour un personnage par ID
PUT http://localhost:8080/personnages/1
Content-Type: application/json
Accept: application/json

{
  "nom": "John Doe",
  "classe": "Mage",
  "niveau": 2,
  "pointsExperience": 200,
  "pointsVie": 120,
  "pointsMana": 80,
  "pointsForce": 12,
  "pointsScore": 10
}

###

# Supprimer un personnage par ID
DELETE http://localhost:8080/personnages/53
Accept: application/json

 

RequestObjet.rest

# Créer un objet
POST http://localhost:8080/objets
Content-Type: application/json
Accept: application/json

{
  "nom": "Epée Excalibur",
  "description": "Une épée tranchante magique",
  "type": "Arme",
   "valeur": 1000,
  "poids": 2.0,
  "effet": "Augmente les dégâts magiques",
  "niveauRequis": 10

}

###

# Obtenir tous les objets
GET http://localhost:8080/objets

###

# Obtenir un objet par ID
GET http://localhost:8080/objets/1

###

# Mettre à jour un objet
PUT http://localhost:8080/objets/1
Content-Type: application/json
Accept: application/json

{
  "nom": "NouveauNom",
  "description": "NouvelleDescription"
}

###

# Supprimer un objet
DELETE http://localhost:8080/objets/1

 

RequestInventaire.rest

# Créer un inventaire
POST http://localhost:8080/inventaires
Content-Type: application/json

{
  "personnage": {
    "id": 2
  },
  "objet": {
    "id": 9
  },
  "quantite": 2
}


###

# Obtenir tous les inventaires
GET http://localhost:8080/inventaires

###

# Obtenir un inventaire par ID
GET http://localhost:8080/inventaires/1

###

# Mettre à jour un inventaire par ID
PUT http://localhost:8080/inventaires/2
Content-Type: application/json

{
  "personnage": {
    "id": 2
    // Autres champs du personnage si nécessaire
  },
  "objet": {
    "id": 9
    // Autres champs de l'objet si nécessaire
  },
  "quantite": 1
}

###

# Augmenter la quantité d'un inventaire par ID
PUT http://localhost:8080/inventaires/increaseQuantity/1

###
# Liste tous les objets dans l'inventaire d'un personnage par ID de personnage
GET http://localhost:8080/inventaires/personnage/2/objets


###

# Supprimer un inventaire
DELETE http://localhost:8080/inventaires/1

 

RequestProfil.rest

# Pour obtenir tous les profils
GET http://localhost:8080/api/profils
Accept: application/json

###

# Pour obtenir un profil par ID
GET http://localhost:8080/api/profils/1
Accept: application/json

###

# Pour créer un nouveau profil
POST http://localhost:8080/api/profils
Content-Type: application/json
Accept: application/json

{
  "name": "Nom du Profil"
}

###

# Pour mettre à jour un profil existant
PUT http://localhost:8080/api/profils/1
Content-Type: application/json
Accept: application/json

{
  "name": "Nouveau Nom du Profil"
}

###

# Pour supprimer un profil existant
DELETE http://localhost:8080/api/profils/1
Accept: application/json

 

RequestAccount.rest

# Pour se connecter
POST http://localhost:8080/account/login
Content-Type: application/json
Accept: application/json

{
  "username": "exemple@email.com",
  "password": "motdepasse"
}

###

# Pour ajouter un nouvel utilisateur
POST http://localhost:8080/account
Content-Type: application/json
Accept: application/json

{
  "email": "exemple@email.com",
  "password": "nouveaumotdepasse"
}

###

# Pour obtenir un utilisateur par son ID
GET http://localhost:8080/account/2
Accept: application/json

###

# Pour obtenir tous les utilisateurs
GET http://localhost:8080/account
Accept: application/json

###

# Pour mettre à jour un utilisateur existant
PUT http://localhost:8080/account/3
Content-Type: application/json
Accept: application/json

{
  "email": "utilisateurmisajour@email.com",
  "password": "motdepassmisajour"
}

###

# Pour supprimer un utilisateur existant
DELETE http://localhost:8080/account/2
Accept: application/json

 

RequestGame.rest

###

# Créer un nouveau personnage
POST http://localhost:8080/game/add
Content-Type: application/json
Accept: application/json

{
  "name": "Super Game 5"

}

###

# Obtenir tous les jeux
GET http://localhost:8080/game/all
Accept: application/json

###

# Mettre à jour un jeu
PUT http://localhost:8080/game/update/3
Content-Type: application/json
Accept: application/json

{
  "name": "Updated Game Name"
}


###

# Supprimer un jeu
DELETE http://localhost:8080/game/delete/2
Accept: application/json

 

 

Modifié le: mercredi 27 septembre 2023, 09:11