commentaire endpoint

PyroFetes/Endpoints/Effect/CreateEffectEndpoint.cs

@@ -4,31 +4,31 @@ using FastEndpoints;
 
 namespace PyroFetes.Endpoints.Effect;
 
-public class CreateEffectEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<CreateEffectDto, GetEffectDto>
+public class CreateEffectEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<CreateEffectDto, GetEffectDto> //Instanciation d'une connexion à la bdd dans un endpoint, utilise l'élément de requête CreateEffectDto et l'élement de réponse GetEffectDto
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Post("Api/effects");
-        AllowAnonymous();
+        Post("Api/effects"); //Créer un effet
+        AllowAnonymous(); //Autorise l'accès sans authentification
     }
 
     public override async Task HandleAsync(CreateEffectDto req, CancellationToken ct)
     {
-        Models.Effect effect = new()
+        Models.Effect effect = new() //Création d'un label rentré par l'utilisateur
         {
             Label = req.Label,
         };
 
-        pyrofetesdbcontext.Effects.Add(effect);
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
-        Console.WriteLine("Effect added");
+        pyrofetesdbcontext.Effects.Add(effect); //Ajoute effect à la bdd
+        await pyrofetesdbcontext.SaveChangesAsync(ct); //Sauvegarde les changements effectués dans la bdd
+        Console.WriteLine("Effect added"); //Affiche Effect added si réussi
 
-        GetEffectDto responseDto = new()
+        GetEffectDto responseDto = new() //Constuire l'objet de réponse pour retourner id et label à l'utilisateur
         {
-            Id = effect.Id,
-            Label = req.Label,
+            Id = effect.Id, //Affiche l'id lors de la réponse
+            Label = req.Label, //Affiche le label 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/Effect/DeleteEffectEndpoint.cs

@@ -9,28 +9,28 @@ public class DeleteEffectRequest
 }
 public class DeleteEffectEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<DeleteEffectRequest>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Delete("Api/effects/{@id}", x => new { x.Id });
-        AllowAnonymous();
+        Delete("Api/effects/{@id}", x => new { x.Id }); //Création d'un endpoint qui supprime un effet grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
     
-    public override async Task HandleAsync(DeleteEffectRequest req, CancellationToken ct)
+    public override async Task HandleAsync(DeleteEffectRequest req, CancellationToken ct) //Méthode asynchrone qui traite la suppression de l'effet
     {
-        Models.Effect? effectToDelete = await pyrofetesdbcontext
-            .Effects
-            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);        
+        Models.Effect? effectToDelete = await pyrofetesdbcontext //Récupère un effet dans la bdd et le stocke dans effectToDelete
+            .Effects //Recherche la couleur dans la table Colors
+            .SingleOrDefaultAsync(a => a.Id == req.Id, cancellationToken: ct);  //Recherche un effet dont l'id correspond à req.Id  
 
-        if (effectToDelete == null)
+        if (effectToDelete == null) //Si l'effet n'est pas trouvé
         {
-            Console.WriteLine($"Aucun effet avec l'ID {req.Id} trouvé.");
-            await Send.NotFoundAsync(ct);
-            return;
+            Console.WriteLine($"Aucun effet avec l'ID {req.Id} trouvé."); //Afficher aucun effet avec l'id ... trouvé
+            await Send.NotFoundAsync(ct); //Renvoie une erreur 404
+            return; //Arrêt de la méthode
         }
 
-        pyrofetesdbcontext.Effects.Remove(effectToDelete);
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
+        pyrofetesdbcontext.Effects.Remove(effectToDelete); //Supprime l'effet 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/Effect/GetAllEffectsEndpoint.cs

@@ -6,22 +6,22 @@ namespace PyroFetes.Endpoints.Effect;
 
 public class GetAllEffectsEndpoint(PyroFetesDbContext pyrofetesdbcontext) : EndpointWithoutRequest<List<GetEffectDto>>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Get("Api/effects");
-        AllowAnonymous();
+        Get("Api/effects"); //Création d'un endpoint pour récupérer tous les effets grâce à la liste
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
 
     public override async Task HandleAsync(CancellationToken ct)
     {
-        List<GetEffectDto> responseDto = await pyrofetesdbcontext.Effects
-            .Select(a => new GetEffectDto
+        List<GetEffectDto> responseDto = await pyrofetesdbcontext.Effects //Création d'une liste qui récupère tous les effets de la bdd
+            .Select(a => new GetEffectDto //Sélectionne dans la liste chaque effet
                 {
-                    Id = a.Id,
-                    Label = a.Label,
+                    Id = a.Id, //Récupère l'id
+                    Label = a.Label, //Récupère le label
                 }
-            ).ToListAsync(ct);
+            ).ToListAsync(ct); //Retourne la liste de effet
 
-        await Send.OkAsync(responseDto, ct);
+        await Send.OkAsync(responseDto, ct); //Envoie de la réponse réussite 200 au client
     }
 }

PyroFetes/Endpoints/Effect/GetEffectEndpoint.cs

@@ -11,31 +11,31 @@ public class GetEffectRequest
 
 public class GetEffectEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<GetEffectRequest, GetEffectDto>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Get("Api/effects/{@id}", x => new { x.Id });
-        AllowAnonymous();
+        Get("Api/effects/{@id}", x => new { x.Id }); //Création d'un endpoint qui récupère un effet grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
 
-    public override async Task HandleAsync(GetEffectRequest req, CancellationToken ct)
+    public override async Task HandleAsync(GetEffectRequest req, CancellationToken ct) //Méthode asynchrone qui traite la récupération de l'effet
     {
-        Models.Effect? effect = await pyrofetesdbcontext
-            .Effects
-            .SingleOrDefaultAsync(x => x.Id == req.Id, cancellationToken: ct);
+        Models.Effect? effect = await pyrofetesdbcontext //Récupère un effet dans la bdd et le stocke dans effect
+            .Effects //Recherche l'effet dans la table Effects
+            .SingleOrDefaultAsync(x => x.Id == req.Id, cancellationToken: ct); //Recherche un effet dont l'id correspond à req.Id  
 
-        if (effect == null)
+        if (effect == null) //Si l'effet n'est pas trouvé
         {
-            Console.WriteLine("Aucun effet avec l'ID {req.Id} trouvé.");
-            await Send.NotFoundAsync(ct);
-            return;
+            Console.WriteLine("Aucun effet avec l'ID {req.Id} trouvé."); //Afficher aucun effet avec l'id ... trouvé
+            await Send.NotFoundAsync(ct); //Renvoie une erreur 404
+            return; //Arrêt de la méthode
         }
 
-        GetEffectDto responseDto = new()
+        GetEffectDto responseDto = new() //Constuire l'objet de réponse pour retourner id et label à l'utilisateur
         {
-            Id = effect.Id,
-            Label = effect.Label,
+            Id = effect.Id, //Affiche l'id lors de la réponse
+            Label = effect.Label, //Affiche le label 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/Effect/UpdateEffectEndpoint.cs

@@ -7,35 +7,32 @@ namespace PyroFetes.Endpoints.Effect;
 
 public class UpdateEffectEndpoint(PyroFetesDbContext pyrofetesdbcontext) : Endpoint<UpdateEffectDto, GetEffectDto>
 {
-    public override void Configure()
+    public override void Configure() //Configuration de l'endpoint
     {
-        Put("Api/effects/{@id}", x => new { x.Id });
-        AllowAnonymous();
+        Put("Api/effects/{@id}", x => new { x.Id }); //Création d'un endpoint qui modifie un effet grâce à son id
+        AllowAnonymous(); //Ignorer les requêtes non authentifiées
     }
 
     public override async Task HandleAsync(UpdateEffectDto req, CancellationToken ct)
     {
-        Models.Effect? effectToEdit = await pyrofetesdbcontext
-            .Effects 
-            .SingleOrDefaultAsync(x => x.Id == req.Id, cancellationToken: ct);
+        Models.Effect? effectToEdit = await pyrofetesdbcontext //Récupère un effet dans la bdd et le stocke dans effectToEdit
+            .Effects  //Recherche l'effet dans la table Effects
+            .SingleOrDefaultAsync(x => x.Id == req.Id, cancellationToken: ct); //Recherche un effet dont l'id correspond à req.Id
 
-        if (effectToEdit == null)
+        if (effectToEdit == null) //Si l'effet n'est pas trouvé
         {
-            Console.WriteLine("Aucun effet avec l'id {req.Id} trouvé.");
-            await Send.NotFoundAsync(ct);
-            return;
-
+            Console.WriteLine($"Aucun effet avec l'id {req.Id} trouvé."); //Afficher qu'aucun effet avec l'id ... n'a été trouvé
+            await Send.NotFoundAsync(ct); //Renvoie une erreur 404
+            return; //Arrêt de la méthode
         }
-        effectToEdit.Label = req.Label;
-        await pyrofetesdbcontext.SaveChangesAsync(ct);
+        effectToEdit.Label = req.Label; //Modification du label de l'effet
+        await pyrofetesdbcontext.SaveChangesAsync(ct); //Sauvegarde les changements effectués dans la base de données
 
-        GetEffectDto responseDto = new()
+        GetEffectDto responseDto = new() //Construire l'objet de réponse pour retourner l'id et le label de l'effet modifié
         {
-            Id = req.Id,
-            Label = req.Label,
+            Id = req.Id, //Inclut l'id dans la réponse
+            Label = req.Label, //Inclut le label dans la réponse
         };
-        await Send.OkAsync(responseDto, ct);
-
+        await Send.OkAsync(responseDto, ct); //Envoie une réponse 200 OK avec l'objet de réponse
     }
-    
 }