From 86db87a6b4e663e2a38b965516bbcaead8e9c9b2 Mon Sep 17 00:00:00 2001 From: Lucas DELANIER Date: Sun, 26 Mar 2023 11:22:03 +0200 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 449fde8..d3634e6 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,22 @@ Une fois le dépot cloné, vous pouvez lancer le code sur votre téléphone Andr ## Archutecture -![](https://codefirst.iut.uca.fr/git/lucas.delanier/LOLProject/raw/branch/master/Documentations/Mask%20group.png) +![](https://codefirst.iut.uca.fr/git/lucas.delanier/LOLProject/raw/branch/master/Documentations/Schema_architecture.png) Ce schéma d'architecure globale permet de comprendre la composition interne de la solution. -Sur la partie gauche on peut voir la partie client qui fait appel a l'api via des requetes http en utilisant les routes de l'api Rest Full. les données renvoyés par l'api son sous le format json. La web API fonctionne grace a un manager stub ainsi que d'une base de données géré par un ORM entity framework. Entity framework permet de gerer une base de données sans avoir a faire de requetes SQL en utilisant un mappeur qui transforme des classes metiers en données en table. +Sur la partie gauche on peut voir la partie client qui fait appel a l'api via des requetes http en utilisant les routes de l'api Rest Full. +Pour tout a fait comprendre, comment communiquent et fonctionnent les différentes briques de la solution nous allons vous détailler brique par brique, relation par relation les différentes point rouge du schéma. + +# 1 # - Le client est une solution qui va intérragir avec notre api grace des requetes sur internet. Il nécessite donc impérativement d'une connexion internet afin de pouvoir communiquer grace a des requetes http(s). Une fois qu'il a récupéré les données demandé. Il doit transoformer ce document json en classe métier de son model. Cela s'appel la déserialization. Ce processus ce traduit ar le code suivant en C#. + +![](https://codefirst.iut.uca.fr/git/lucas.delanier/LOLProject/raw/branch/master/Documentations/Capture%20d%27%C3%A9cran%202023-03-26%20111526.png) + + +# 2 # - Maintenant que vous savez comment le client traite les données renvoyées par l'API, nous allons a présent voir comment ils communiquent entre eux. Cette communication se fait par des requetes http(s) sous la forme suivante. + +"codefirst.iut.uca.fr/containers/lucasdelanier-containerlol/api/v{version}/{controller}" + +Lors de l'appel de l'API, le client peut choisir la version ( v1, v2, etc) mais aussi indiquer le controlleur qu'il souhaite intérroger. Par exemple Champion lui permettra de récuperer des informations sur les champions que connait l'API. Il est aussi possible de rajouter de précisions en ajoutant par exemple un nom apres le controller pour demander les informations spécifique a un champion en particulié. ## :wrench: SUPPORT En cas de problème lors de l'utilisation de l'application, vous pouvez nous contacter aux adresses suivantes :