commentaire endpoint

PyroFetes/Endpoints/Movement/CreateMovementEndpoint.cs

@@ -4,18 +4,18 @@ using FastEndpoints;
 
 namespace PyroFetes.Endpoints.Movement;
 
-public class CreateMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<CreateMovementDto, GetMovementDto>
+public class CreateMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<CreateMovementDto, GetMovementDto> //Instanciation d'une connexion à la bdd dans un endpoint, utilise l'élément de requête CreateMovementDto et l'élement de réponse GetMovementDto
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Post("/api/movements");
-        AllowAnonymous();
+        Post("/api/movements"); //Créer un mouvement 
+        AllowAnonymous(); //Autorise l'accès sans authentification
     }
 
     public override async Task HandleAsync(CreateMovementDto req, CancellationToken ct)
     {
         
-        Models.Movement movement = new ()
+        Models.Movement movement = new () //Création d'une date, d'une date de départ, d'arrivée et d'une quantité rentré par l'utilisateur
         {
             Date = req.Date,
             Start = req.Start,
@@ -23,19 +23,19 @@ public class CreateMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : End
             Quantity = req.Quantity
         };
         
-        pyrofetesdbcontext.Movements.Add(movement);
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
+        pyrofetesdbcontext.Movements.Add(movement); //Ajoute movement à la bdd
+        await pyrofetesdbcontext.SaveChangesAsync(ct); //Sauvegarde les changements effectués dans la bdd
         
-        Console.WriteLine("Movement créée avec succès !");
+        Console.WriteLine("Movement créée avec succès !"); //Affiche Movement créée avec succès ! si réussi
 
-        GetMovementDto responseDto = new ()
+        GetMovementDto responseDto = new () //Constuire l'objet de réponse pour retourner les informations à l'utilisateur
         {
-            Date = req.Date,
-            Start = req.Start,
-            Arrival = req.Arrival,
-            Quantity = req.Quantity
+            Date = req.Date, //Affiche date lors de la réponse
+            Start = req.Start, //Affiche start lors de la réponse
+            Arrival = req.Arrival, //Affiche arrival lors de la réponse
+            Quantity = req.Quantity //Affiche quantity lors de la réponse
         };
 
-        await Send.OkAsync(responseDto, ct);
+        await Send.OkAsync(responseDto, ct); //Envoie de la réponse réussite 200 au client
     }
 }

PyroFetes/Endpoints/Movement/DeleteMovementEndpoint.cs

@@ -3,36 +3,36 @@ using Microsoft.EntityFrameworkCore;
 
 namespace PyroFetes.Endpoints.Movement;
 
-public class DeleteMovementRequest
+public class DeleteMovementRequest //Création d'une classe DeleteMovementRequest
 {
-    public int  Id  { get; set; }
+    public int  Id  { get; set; } //Création d'un Id
 }
 
 public class DeleteMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<DeleteMovementRequest>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Delete("/api/Movements/{@id}", x => new { x.Id });
-        AllowAnonymous();
+        Delete("/api/Movements/{@id}", x => new { x.Id }); //Création d'un endpoint qui supprime un mouvement grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
     
-    public override async Task HandleAsync(DeleteMovementRequest req, CancellationToken ct)
+    public override async Task HandleAsync(DeleteMovementRequest req, CancellationToken ct) //Méthode asynchrone qui traite la suppression du mouvement
     {
         
-        Models.Movement? movementToDelete = await pyrofetesdbcontext
-            .Movements
-            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);
+        Models.Movement? movementToDelete = await pyrofetesdbcontext //Récupère un mouvement dans la bdd et le stocke dans movementToDelete
+            .Movements //Recherche le mouvement dans la table Movements
+            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);//Recherche une mouvement dont l'id correspond à req.Id  
 
-        if (movementToDelete == null)
+        if (movementToDelete == null) //Si le mouvement n'est pas trouvé
         {
-            Console.WriteLine($"Aucune mouvement avec l'ID {req.Id} trouvé.");
-            await Send.NotFoundAsync(ct);
-            return;
+            Console.WriteLine($"Aucune mouvement avec l'ID {req.Id} trouvé."); //Affiche aucun mouvement avec l'id ... trouvé
+            await Send.NotFoundAsync(ct); //Renvoie une erreur 404
+            return; //Arrêt de la méthode
         }
 
-        pyrofetesdbcontext.Movements.Remove(movementToDelete);
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
+        pyrofetesdbcontext.Movements.Remove(movementToDelete); //Supprime le mouvement dans la bdd
+        await pyrofetesdbcontext.SaveChangesAsync(ct); //Sauvegarde les changements effectués dans la bdd
 
-        await Send.NoContentAsync(ct);
+        await Send.NoContentAsync(ct); //Renvoie une réponse réussite 204 
     }
 }

PyroFetes/Endpoints/Movement/GetAllMovementsEndpoint.cs

@@ -6,26 +6,26 @@ namespace PyroFetes.Endpoints.Movement;
 
 public class GetAllMovementsEndpoint(PyroFetesDbContext pyrofetesdbcontext) : EndpointWithoutRequest<List<GetMovementDto>>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Get("/api/movements");
-        AllowAnonymous();
+        Get("/api/movements"); //Création d'un endpoint pour récupérer tous les mouvements grâce à la liste
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
 
     public override async Task HandleAsync(CancellationToken ct)
     {
         
-        List<GetMovementDto> responseDto = await pyrofetesdbcontext.Movements
-            .Select(a => new GetMovementDto
+        List<GetMovementDto> responseDto = await pyrofetesdbcontext.Movements //Création d'une liste qui récupère tous les mouvements de la bdd
+            .Select(a => new GetMovementDto //Sélectionne dans la liste chaque mouvement
                 {
-                    Id = a.Id,
-                    Date = a.Date,
-                    Start = a.Start,
-                    Arrival = a.Arrival,
-                    Quantity = a.Quantity
+                    Id = a.Id, //Récupère l'id
+                    Date = a.Date, //Récupère la date
+                    Start = a.Start, //Récupère start
+                    Arrival = a.Arrival, //Récupère arrival
+                    Quantity = a.Quantity //Récupère quantity
                 }
-            ).ToListAsync(ct);
+            ).ToListAsync(ct); //Retourne la liste de mouvement 
 
-        await Send.OkAsync(responseDto, ct);
+        await Send.OkAsync(responseDto, ct); //Envoie de la réponse réussite 200 au client
     }
 }

PyroFetes/Endpoints/Movement/GetMovementEndpoint.cs

@@ -11,35 +11,35 @@ public class GetMovementRequest
 
 public class GetMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) :Endpoint<GetMovementRequest, GetMovementDto>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Get("/api/movements/{@id}", x => new { x.Id });
-        AllowAnonymous();
+        Get("/api/movements/{@id}", x => new { x.Id }); //Création d'un endpoint qui récupère un mouvement grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
 
-    public override async Task HandleAsync(GetMovementRequest req, CancellationToken ct)
+    public override async Task HandleAsync(GetMovementRequest req, CancellationToken ct) //Méthode asynchrone qui traite la récupération du mouvement
     {
         
-        Models.Movement? movement = await pyrofetesdbcontext
-            .Movements
-            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);
+        Models.Movement? movement = await pyrofetesdbcontext //Récupère un mouvement dans la bdd et le stocke dans movement
+            .Movements //Recherche la couleur dans la table Movements
+            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);//Recherche un mouvement dont l'id correspond à req.Id  
 
-        if (movement == null)
+        if (movement == null) //Si le mouvement n'est pas trouvé
         {
-            Console.WriteLine($"Aucun mouvement avec l'ID {req.Id} trouvé.");
-            await Send.NotFoundAsync(ct);
-            return;
+            Console.WriteLine($"Aucun mouvement avec l'ID {req.Id} trouvé."); //Affiche aucun mouvement avec l'id ... trouvé
+            await Send.NotFoundAsync(ct); //Renvoie une erreur 404
+            return; //Arrêt de la méthode
         }
 
-        GetMovementDto responseDto = new()
+        GetMovementDto responseDto = new() //Constuire l'objet de réponse pour retourner les informations à l'utilisateur
         {
-            Id = req.Id, 
-            Date = movement.Date,
-            Start = movement.Start,
-            Arrival = movement.Arrival,
-            Quantity = movement.Quantity
+            Id = req.Id,  //Affiche l'id lors de la réponse
+            Date = movement.Date, //Affiche date lors de la réponse
+            Start = movement.Start, //Affiche start lors de la réponse
+            Arrival = movement.Arrival, //Affiche arrival lors de la réponse
+            Quantity = movement.Quantity //Affiche quantity lors de la réponse
         };
 
-        await Send.OkAsync(responseDto, ct);
+        await Send.OkAsync(responseDto, ct); //Envoie de la réponse réussite 200 au client
     }
 }

PyroFetes/Endpoints/Movement/UpdateMovementEndpoint.cs

@@ -6,26 +6,26 @@ namespace PyroFetes.Endpoints.Movement;
 
 public class UpdateMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<UpdateMovementDto, GetMovementDto>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Put("/api/movements");
-        AllowAnonymous();
+        Put("/api/movements"); //Création d'un endpoint qui modifie le mouvement grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
     
     public override async Task HandleAsync(UpdateMovementDto req, CancellationToken ct)
     {
         
-        Models.Movement movement = new()
+        Models.Movement movement = new() 
         {
             Date = req.Date,
             Start = req.Start,
             Arrival = req.Arrival,
             Quantity = req.Quantity
         };
-        pyrofetesdbcontext.Add(movement);
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
+        pyrofetesdbcontext.Add(movement); //Modification du mouvement
+        await pyrofetesdbcontext.SaveChangesAsync(ct); //Sauvegarde les changements effectués dans la bdd
 
-        GetMovementDto response = new()
+        GetMovementDto response = new() //Constuire l'objet de réponse pour retourner les informations du mouvement
         {
             Id = req.Id,
             Date = req.Date,
@@ -34,7 +34,7 @@ public class UpdateMovementEndpoint(PyroFetesDbContext pyrofetesdbcontext) : End
             Quantity = req.Quantity
         };
 
-        await Send.OkAsync(response, ct);
+        await Send.OkAsync(response, ct); //Envoie de la réponse réussite 200 au client
 
     }
 }