Infra : Architecture du code

Last updated 8 months ago

Ci-dessous un schéma représentant les éléments principaux de l'application, leurs relations entre eux ainsi que le tracé du traitement d'une requête faite aux APIs.

Traitement de requêtes

Lors de la réception d'une requête, celle-ci est filtrée par le routeur puis dispatchée au bon contrôleur qui va se charger de constituer la réponse à renvoyer (traitement classique par une application Rails).

Après s'être assuré de l'authentification de la requête, le contrôleur fait appel à sonRetriever_chargé de créer la réponse à la requête. Pour cela, il se peut que le_Retriever_ait à agréger des données issues de sources différentes. C'est pourquoi le_Retriever_fait appel à des_Drivers.

Responsabilités

Sont documentés ici les responsabilités des différents éléments impliqués dans le traitement d'une requête soumise à l'application.

Routeur et contrôleur

Le routeur et les contrôleurs n'ont ici rien de particulier. Ce sont les couches d'une architecture MVC classique et leur rôle n'a rien de spécifique dans le cas du projetAPIEntreprise.

Les Drivers

Les_Drivers_sont les éléments chargés de créer les requêtes et d'en parser les réponses pour une source de données précise et unique. A un fournisseur de données (INSEE, Greffe, …) est donc associé un_Driver_spécifique. Un_Driver_a pour responsabilité de :

  • constituer la requête (Request) et l'exécuter ;

  • parser de la réponse (Response) pour en extraire les données cibles ;

  • fournir ces données, ou le code d'erreur reçu en réponse à la Request, au Retriever

Les Retrievers

Les _Retrievers _sont en général en relation 1-1 avec un contrôleur. Leur rôle consiste à :

  • Aiguiller la requête vers les _Drivers _correspondant. Il est de la responsabilité d'un _Retriever _de savoir à quels _Drivers _faire appel ;

  • Agréger les données renvoyées par les différents _Drivers _et constituer le corps de la réponse à fournir au contrôleur.

Request et Response