boysimon10 / checkpoint-rest-api Goto Github PK

Ce guide fournit des instructions sur la façon de tester l'API Rest Checkpoint à l'aide de Postman. L'API comprend des opérations CRUD de base pour la gestion des données utilisateur (nom d'utilisateur, e-mail et mot de passe).

1. Cloner le Dépôt :

   git clone https://github.com/votre-nom-utilisateur/checkpoint-rest-api.git
   cd checkpoint-rest-api

2. Installer les Dépendances :

   npm install

3. Configurer les Variables d'Environnement :

   • Créez un fichier .env dans le dossier config.
   • Ajoutez les variables d'environnement suivantes :

     PORT=3000
     MONGODB_URI=your_mongo_uri

4. Démarrer le Serveur :

   node server.js

   Le serveur s'exécutera sur le port spécifié (par défaut 3000). Assurez-vous que MongoDB est en cours d'exécution et accessible.

• Sélectionnez la méthode GET.
• Entrez l'URL pour récupérer tous les utilisateurs : http://localhost:3000/users.
• Cliquez sur le bouton "Send". Vous devriez recevoir une réponse avec la liste des utilisateurs.

• Sélectionnez la méthode POST.
• Entrez l'URL pour ajouter un nouvel utilisateur : http://localhost:3000/users.
• Dans l'onglet "Body", sélectionnez "raw" et choisissez "JSON (application/json)".
• Entrez les données de l'utilisateur dans le corps de la requête :

  {
    "username": "nouvelUtilisateur",
    "email": "[email protected]",
    "password": "motDePasseSécurisé"
  }

• Cliquez sur le bouton "Send". Vous devriez recevoir une réponse avec les détails du nouvel utilisateur ajouté.

• Sélectionnez la méthode PUT.
• Entrez l'URL pour mettre à jour un utilisateur par ID (remplacez votreIdUtilisateur par l'ID réel) : http://localhost:3000/users/votreIdUtilisateur.
• Dans l'onglet "Body", sélectionnez "raw" et choisissez "JSON (application/json)".
• Entrez les champs à mettre à jour dans le corps de la requête :

  {
    "username": "nomUtilisateurMisÀJour",
    "email": "[email protected]",
    "password": "motDePasseMisÀJour"
  }

• Cliquez sur le bouton "Send". Vous devriez recevoir une réponse avec les détails de l'utilisateur mis à jour.

• Sélectionnez la méthode DELETE.
• Entrez l'URL pour supprimer un utilisateur par ID (remplacez votreIdUtilisateur par l'ID réel) : http://localhost:3000/users/votreIdUtilisateur.
• Cliquez sur le bouton "Send". Vous devriez recevoir une réponse avec les détails de l'utilisateur supprimé.

• Assurez-vous que la base de données MongoDB est en cours d'exécution et accessible.
• Gérez les variables d'environnement dans le fichier .env situé dans le dossier config.
• Personnalisez les données dans les corps de requête selon vos besoins.

N'hésitez pas à explorer et à tester l'API Rest Checkpoint avec Postman en suivant ces instructions.