# becastellani/nodeapimongo architecture

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

- Interactive diagram: https://gitdiagram.com/becastellani/nodeapimongo
- Repository: https://github.com/becastellani/nodeapimongo

## Overview

##### Project type and purpose
- This is a backend‐only Node.js REST API for managing users, products, orders and debtors.
- It uses Express for HTTP routing, Mongoose/MongoDB for persistence, RabbitMQ for asynchronous messaging, and Swagger for API documentation.

##### File structure
- src/server.js & src/app.js: application entry point
- src/routes.js & src/routers/*.js: HTTP routing layer (route definitions + per‐route validators)
- src/middlewares: request validation, error handling, HATEOAS link injection, whitelist filtering
- src/controllers: business logic for each resource (auth, user, product, order, debtor, task)
- src/services/publish.js: RabbitMQ publishing utility
- src/models/*.js: Mongoose schemas/models for each collection
- src/config: DB connection config and Swagger JSON
- src/swagger.js: swagger integration

##### README for additional insights
- Tech stack: Node.js, Express, MongoDB (via Mongoose), RabbitMQ, Swagger
- Workflow notes:
- On order creation: API publishes to RabbitMQ “debt” queue
- Debtor consumer picks up “debt” messages, creates a debit record, then publishes status update to “order” queue
- Order logic listens for “order” queue to update order status

##### Detail and coverage
- Don’t over‐simplify: show both the request‐validation middleware and error/response flows
“A client makes an HTTP request → Express routes → controller logic → data store or message broker → consumer logic → back to data store or API response.”

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["REST Client"]:::client

    subgraph "API Server"
        subgraph "HTTP Layer"
            Routes["Express Router\n(src/routes.js + routers/*.js)"]:::http
            Helpers["Error Handlers\n(src/routers/helpers/404.js, 500.js)"]:::http
        end
        subgraph "Middlewares"
            ValidatorMW["validator.js"]:::middleware
            HandlerMW["handler.js"]:::middleware
            HATEOASMW["hateos.js"]:::middleware
            WhitelistMW["whitelist.js"]:::middleware
        end
        subgraph "Controllers"
            AuthC["AuthController"]:::business
            UserC["UserController"]:::business
            ProdC["ProductController"]:::business
            OrderC["OrderController"]:::business
            DebtorC["DebtorController"]:::business
            TaskC["TaskController"]:::business
        end
        subgraph "Services"
            Publish["publish.js"]:::service
            DebtorConsumer["DebtorConsumer"]:::service
            OrderConsumer["OrderConsumer"]:::service
        end
        subgraph "Models"
            UserM["userModel.js"]:::data
            ProdM["productModel.js"]:::data
            OrderM["orderModel.js"]:::data
            DebtorM["debtorModel.js"]:::data
            TaskM["taskModel.js"]:::data
        end
        Swagger["Swagger UI\n(src/swagger.js)"]:::docs
    end

    DB["MongoDB"]:::db
    Rabbit["RabbitMQ"]:::broker
    DebtQ["debt queue"]:::broker
    OrderQ["order queue"]:::broker

    Client -->|HTTP| Routes
    Routes -->|404/500| Helpers
    Helpers --> ValidatorMW
    ValidatorMW --> HandlerMW
    HandlerMW --> HATEOASMW
    HATEOASMW --> WhitelistMW
    WhitelistMW --> Controllers

    Controllers -->|Mongoose| Models
    OrderC -->|publish debt| Publish
    Publish -->|to| DebtQ
    DebtQ -.-> DebtorConsumer
    DebtorConsumer -->|create debtor| DebtorM
    DebtorConsumer -->|publish order| Publish
    Publish -->|to| OrderQ
    OrderQ -.-> OrderConsumer
    OrderConsumer -->|update status| OrderM

    Models -.-> DB
    Publish -.-> Rabbit
    Rabbit --> DebtQ
    Rabbit --> OrderQ
    Client -->|view docs| Swagger

    click Routes "https://github.com/becastellani/nodeapimongo/blob/main/src/routes.js"
    click ValidatorMW "https://github.com/becastellani/nodeapimongo/blob/main/src/middlewares/validator.js"
    click HandlerMW "https://github.com/becastellani/nodeapimongo/blob/main/src/middlewares/handler.js"
    click HATEOASMW "https://github.com/becastellani/nodeapimongo/blob/main/src/middlewares/hateos.js"
    click WhitelistMW "https://github.com/becastellani/nodeapimongo/blob/main/src/middlewares/whitelist.js"
    click AuthC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/authController.js"
    click UserC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/userController.js"
    click ProdC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/productController.js"
    click OrderC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/orderController.js"
    click DebtorC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/debtorController.js"
    click TaskC "https://github.com/becastellani/nodeapimongo/blob/main/src/controllers/taskController.js"
    click Publish "https://github.com/becastellani/nodeapimongo/blob/main/src/services/publish.js"
    click UserM "https://github.com/becastellani/nodeapimongo/blob/main/src/models/userModel.js"
    click ProdM "https://github.com/becastellani/nodeapimongo/blob/main/src/models/productModel.js"
    click OrderM "https://github.com/becastellani/nodeapimongo/blob/main/src/models/orderModel.js"
    click DebtorM "https://github.com/becastellani/nodeapimongo/blob/main/src/models/debtorModel.js"
    click TaskM "https://github.com/becastellani/nodeapimongo/blob/main/src/models/taskModel.js"
    click Swagger "https://github.com/becastellani/nodeapimongo/blob/main/src/swagger.js"

    classDef client fill:#D6E9F8,stroke:#31708F
    classDef http fill:#D9EDF7,stroke:#31708F
    classDef middleware fill:#FCF8E3,stroke:#8A6D3B
    classDef business fill:#DFF0D8,stroke:#3C763D
    classDef service fill:#F5ECCE,stroke:#8A6D3B
    classDef data fill:#F2DEDE,stroke:#A94442
    classDef db fill:#DFF0D8,stroke:#3C763D,stroke-width:2px
    classDef broker fill:#FCF8E3,stroke:#8A6D3B,stroke-width:2px
    classDef docs fill:#D9EDF7,stroke:#31708F
```
