Aller au contenu principal

Résumé

L'API frontend sert d'intermédiaire entre le frontend et la base de données. Elle est donc développée pour fournir directement les informations utiles au frontend, ainsi que de réaliser certaines opérations sur les données.

L'API a été développé en suivant l'architecture hexagonale, ce qui permet de facilement la faire évoluer en ajoutant de nouvelles routes, ou en changeant de base de données par exemple. Elle est divisée en trois grandes catégories de fichiers :

  • Les services qui font la liaison entre l'API et la base de données
  • Les use-cases qui décrivent les actions que l'on veut réaliser sur les données
  • Les controllers qui exposent les différentes routes de l'API, et qui font appels aux use-cases pour réaliser les opérations

Avec l'API, un fichier Swagger est disponible. Celui-ci documente toutes les routes disponibles, ainsi que les données attendues.