# franckygires/fintech-payment-api architecture

> Architecture diagram of the GitHub repository franckygires/fintech-payment-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/franckygires/fintech-payment-api
- Repository: https://github.com/franckygires/fintech-payment-api

## Overview

Pour réaliser un **diagramme d’architecture** précis et complet pour l’API de paiement avec Paystack, suivez ces étapes adaptées à votre projet :

##### Identifier le type de projet et son objectif
- C’est une **API back-end** (microservice) écrite en **TypeScript** avec **Node.js** et **Express**, qui expose deux opérations :
a. Initialisation d’un paiement via l’API Paystack
b. Vérification du statut d’un paiement
- La persistance se fait dans **MongoDB** et l’ensemble est conteneurisé via **Docker**/Docker Compose.

##### Analyser la structure du projet
- Top-level :
- Dockerfile & docker-compose.yml → orchestration des conteneurs
- src/ → code applicatif
- public/assets → captures d’écran dans la doc
- tests/ → tests unitaires
- src/ détail :
- config/db.ts → connexion à MongoDB
- controllers/paymentController.ts → logique des endpoints
- services/paystackService.ts → intégration avec l’API Paystack
- models/Transaction.ts → schéma Mongoose
- routes/paymentRoutes.ts → définition des routes Express
- middlewares/requestLogger.ts → logging des requêtes
- utils/logger.ts → utilitaire de journalisation
- app.ts et server.ts → bootstrap de l’application Express

##### Compléments tirés du README
- Variables d’environnement pour MongoDB & Paystack
- Ports : application (5001), MongoDB (27017/27018)
- Commandes Docker Compose pour le dev et la prod
- Structure et rôle de chaque dossier

##### Composer le diagramme d’architecture
a. Composants principaux (représentez chaque bloc par un rectangle ou un conteneur) :
1. Client (Postman / frontend hypothétique)
2. Conteneur “API App” (Node.js + Express + TypeScript)
3. Service Paystack (API externe)
4. Conteneur “MongoDB”
5. Docker Compose (pour indiquer l’orchestrateur)
b. Flots d’interaction (avec des flèches directionnelles) :
- Client → API App : requête HTTP POST /api/payments/initiate
- API App → PaystackService : appel HTTPS (initiation ou vérification)
- PaystackService → Paystack (API externe) : échange de données JSON
- API App → MongoDB (via Mongoose) : création/mise à jour du document Transaction
- API App → Client : réponse JSON avec URL d’auth. ou statut
c. Patterns et principes architecturaux :
- **Layered Architecture** :
- Routes → Controllers → Services → Database
- **Separation of Concerns** : indépendance du service Paystack, du logger, etc.
- **12-factor app** : configuration via variables d’environnement
d. Technologies clés à annoter :
- Node.js, Express, TypeScript
- MongoDB (Mongoose)
- Docker & Docker Compose
- Jest pour les tests unitaires

##### Conseils de mise en forme du diagramme
- Utiliser des **formes et couleurs** différentes :
- Conteneurs Docker (rectangles à bord épais, couleur bleu clair)
- Services externes (nuage ou forme arrondie, couleur grise)
- Composants internes (rectangles, couleur blanche ou pastel)
- Bases de données (cylindre, couleur orange)
- **Labels clairs** sur chaque bloc : nom du fichier principal (ex. “app.ts”) ou rôle (ex. “PaymentController”)
- **Flèches** et **numérotation** facultative pour indiquer l’ordre des appels
- Légende en bas à droite si vous utilisez des symboles ou codes couleur

##### Particularités de ce projet
- Montrez deux conteneurs Docker (app + mongo) gérés par Compose
- Insérez un bloc “Env Vars” pour illustrer la gestion de la configuration
- Ajoutez un sous-bloc “Tests (Jest)” pour indiquer la présence d’une suite de tests

En suivant ce schéma, vous obtiendrez un diagramme exhaustif qui reflète fidèlement la structure (dossiers/fichiers) et le comportement (flux de données) de l’API de paiement. Assurez-vous que chaque composant essentiel soit représenté, que les flèches montrent explicitement les interactions, et que les technologies soient listées ou annotées pour offrir une vue d’ensemble immédiatement exploitable par l’équipe.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["Client (Postman)"]:::external

    %% Docker Orchestration
    subgraph "Docker Orchestration"
        direction TB
        Dockerfile["Dockerfile"]:::docker
        Compose["docker-compose.yml"]:::docker
    end

    %% External Paystack Service
    Paystack["Paystack API"]:::external

    %% MongoDB Container
    subgraph "MongoDB Container"
        direction TB
        MongoDB["MongoDB"]:::db
    end

    %% API Application Container
    subgraph "API App (Node.js + Express + TypeScript)" 
        direction TB

        EnvVars["Env Vars (.env.example)"]:::config

        subgraph "Bootstrap"
            direction TB
            AppTs["app.ts"]:::internal
            ServerTs["server.ts"]:::internal
        end

        subgraph "Routing Layer"
            direction TB
            PaymentRoutes["paymentRoutes.ts"]:::internal
        end

        subgraph "Controller Layer"
            direction TB
            PaymentController["paymentController.ts"]:::internal
        end

        subgraph "Service Layer"
            direction TB
            PaystackService["paystackService.ts"]:::internal
        end

        subgraph "Data Model Layer"
            direction TB
            TransactionModel["Transaction.ts"]:::internal
        end

        subgraph "Middleware"
            direction TB
            RequestLogger["requestLogger.ts"]:::internal
        end

        subgraph "Utility"
            direction TB
            LoggerUtil["logger.ts"]:::internal
        end

        subgraph "Tests (Jest)"
            direction TB
            JestConfig["jest.config.js"]:::test
            PaymentTest["payment.test.ts"]:::test
        end

    end

    %% Public Assets
    PublicAssets["public/assets"]:::asset

    %% Flows
    Client -->|"POST /api/payments/initiate"| PaymentRoutes
    PaymentRoutes -->|"calls"| PaymentController
    PaymentController -->|"uses"| PaystackService
    PaystackService -->|"HTTPS request"| Paystack
    PaymentController -->|"CRUD"| TransactionModel
    PaymentController -->|"responds"| Client

    %% Bootstrap flows
    AppTs --> ServerTs
    ServerTs --> EnvVars
    ServerTs --> PaymentRoutes
    ServerTs --> RequestLogger
    ServerTs --> LoggerUtil
    ServerTs --> TransactionModel
    ServerTs --> PaystackService

    %% Docker orchestration flows
    Compose --> Dockerfile
    Compose -->|"orchestrates"| MongoDB
    Compose -->|"orchestrates"| APIAppContainer[("API App (Container)")]:::docker
    APIAppContainer -->|"runs"| Dockerfile

    %% MongoDB flow
    PaymentController -->|"connects"| MongoDB

    %% Public assets link
    ServerTs --> PublicAssets

    %% Click Events
    click Dockerfile "https://github.com/franckygires/fintech-payment-api/tree/main/Dockerfile"
    click Compose "https://github.com/franckygires/fintech-payment-api/blob/main/compose.yml"
    click EnvVars "https://github.com/franckygires/fintech-payment-api/blob/main/.env.example"
    click AppTs "https://github.com/franckygires/fintech-payment-api/blob/main/src/app.ts"
    click ServerTs "https://github.com/franckygires/fintech-payment-api/blob/main/src/server.ts"
    click DbConfig "https://github.com/franckygires/fintech-payment-api/blob/main/src/config/db.ts"
    click PaymentRoutes "https://github.com/franckygires/fintech-payment-api/blob/main/src/routes/paymentRoutes.ts"
    click PaymentController "https://github.com/franckygires/fintech-payment-api/blob/main/src/controllers/paymentController.ts"
    click PaystackService "https://github.com/franckygires/fintech-payment-api/blob/main/src/services/paystackService.ts"
    click TransactionModel "https://github.com/franckygires/fintech-payment-api/blob/main/src/models/Transaction.ts"
    click RequestLogger "https://github.com/franckygires/fintech-payment-api/blob/main/src/middlewares/requestLogger.ts"
    click LoggerUtil "https://github.com/franckygires/fintech-payment-api/blob/main/src/utils/logger.ts"
    click PublicAssets "https://github.com/franckygires/fintech-payment-api/tree/main/public/assets"
    click JestConfig "https://github.com/franckygires/fintech-payment-api/blob/main/jest.config.js"
    click PaymentTest "https://github.com/franckygires/fintech-payment-api/blob/main/tests/payment.test.ts"

    %% Styles
    classDef docker fill:#E0F7FA stroke:#0288D1,stroke-width:2px
    classDef external fill:#ECEFF1 stroke:#B0BEC5,stroke-width:1px
    classDef internal fill:#FFFFFF stroke:#90A4AE,stroke-width:1px
    classDef db fill:#FFE0B2 stroke:#FF9800,stroke-width:2px
    classDef config fill:#E8F5E9 stroke:#2E7D32,stroke-width:1px
    classDef test fill:#F3E5F5 stroke:#6A1B9A,stroke-width:1px
    classDef asset fill:#FFF3E0 stroke:#EF6C00,stroke-width:1px
```
