From 196d9b2171f8651db266112377005efef46090a7 Mon Sep 17 00:00:00 2001 From: Damien NORTIER Date: Thu, 28 Mar 2024 15:08:09 +0100 Subject: [PATCH] doc : ajout de documentation pour la partie WebAPI --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e024c52..af04670 100755 --- a/README.md +++ b/README.md @@ -82,9 +82,8 @@ Nécessite un fichier Config_DB.php pour fonctionner, n'hésitez pas à nous le ## API ASP.NET Comme dit, cette partie est sur cette branche. La solution et les projets se situent dans le dossier WebApi. - J'ai été trop ambitieux, je pensais aller plus rapidement en codant toute l'application d'abord puis en testant. J'ai donc codé tout le projet, cependant, je n'ai eu le temps - de tester que les managers d'une answer. - Ce manque de temps est notamment dû à des erreurs incomprisent et à une mauvaise injection de dépendance (et aussi car nous n'avions pas beaucoup d'heure de SAE). + J'ai été trop ambitieux, je pensais aller plus rapidement en codant toute l'application d'abord puis en testant. J'ai donc codé tout le projet, cependant, je n'ai eu le temps de tester que les managers d'une answer. + Ce manque de temps est notamment dû à des erreurs incomprisent et à une mauvaise injection de dépendance. ### voici comment s'organise le projet : ```plantuml @@ -231,9 +230,22 @@ Nécessite un fichier Config_DB.php pour fonctionner, n'hésitez pas à nous le - une fonction Test appelant les fonctions TestXXX - le programme construit un StubbedDbContext puis appel la méthode 'Test' - ### concernant la documentation : + ### concernant la documentation + - toutes les classes sont documentées - les managers ne sont pas documentés (j'ai décidé de documenté juste les interfaces car les documentations des managers auraient été similaires). - les tests sont moins documentés que le reste + ### la classe Unit + + La classe Unit n'est pas un Unit Of Work. Elle sert simplement à rassembler toutes les méthodes en une seule classe afin que les Controllers puissent accéder aux méthodes permettant la vérification des dépendances. Par exemple, à la création d'une question, le Contrôleur des questions doit pouvoir accéder à la méthode permettant d'obtenir un chapitre + + ### les contrôleurs + + J'ai décidé de créer plusieurs contrôleurs : un contrôleur pour chaque classe et un FrontController + + **Pourquoi un FrontController ?** + + Pour plus de lisibilité, j'ai pensé qu'il était préférable de séparé la déclaration d'une route de sa documentation (les [HttpGet(...)], [ProduceResponseType(...)], ...). Cependant, afin de ne pas faire trop de fichiers, je n'ai pas voulu faire un contrôleur par classe + par GUITARD Maxence, VAN BRABRANDT Jade, DUCOURTHIAL Jérémy, CALATAYUD Yvan, NORTIER Damien \ No newline at end of file