Bienvenue sur le Portail de Documentation ZORNI

Figure 1 : Logo de l'application ZORNI

Présentation du Portail de Documentation

Ce portail vous offre une vue complète et structurée de la documentation relative au projet ZORNI. Il est conçu pour fournir aux utilisateurs et développeurs toutes les informations nécessaires pour comprendre, intégrer et exploiter les fonctionnalités offertes par ce projet.

Contenu du Portail

Documentation
La section Documentation présente les SFD (Specification Fonctionnelle Détaillée) du projet ZORNI. Ces documents décrivent en détail les processus métier, les flux de données et les interactions entre les différents composants du système. Ils constituent une ressource essentielle pour comprendre le fonctionnement interne du projet.
APIs Doc
La section APIs Doc constitue la partie technique centrale de ce portail. Elle regroupe les contrats d'interface de toutes les APIs du projet ZORNI. Ces contrats sont générés automatiquement via le projet zorni-generator-lib, en utilisant la bibliothèque Redocly, à partir des spécifications OpenAPI 3.0. Ils fournissent une description détaillée des endpoints, des paramètres, des exemples de requêtes et de réponses, ainsi que des codes d'état HTTP associés. Les APIs documentées incluent :
- Persons API
- Partners API
- Travels API
- Transactions API
- Communications API
- Notifications API
- Upload API
- Task API
Dossier d'architecture
La section Dossier d'architecture met à disposition le dossier complet décrivant l'architecture technique du projet ZORNI. Ce dossier inclut :
- Les diagrammes d'architecture globale,
- Les descriptions des différentes couches du système,
- Les choix technologiques retenus,
- Les principes de conception adoptés.

Objectif du Portail

Le principal objectif de ce portail est de centraliser toute la documentation nécessaire pour :

Faciliter l'intégration et la consommation des APIs ZORNI,
Offrir une compréhension approfondie du fonctionnement du système,
Fournir un support technique complet pour les équipes de développement et d'exploitation.