# jona712/api-petclinic architecture

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

- Interactive diagram: https://gitdiagram.com/jona712/api-petclinic
- Repository: https://github.com/jona712/api-petclinic

## Overview

##### Project Type and Purpose
- It is a back-end API built in Node.js designed to manage a veterinary clinic’s data (such as appointments, users, products, services, and reservations).
- It leverages Prisma to interact with a MySQL database and includes modules for image/file upload and scheduled notification tasks via Node Cron and Nodemailer.

##### File Structure
- Top-level files like app.js give the entry point for the Node.js server.
- The “controllers” directory contains various controllers (e.g., usuarioController.js, facturaController.js, reservaController.js) that implement the business logic behind API endpoints.
- “routes” folder defines the API endpoints and maps them to the corresponding controller functions.
- “middleware” includes authentication and file upload logic – these are used to secure and support file handling on the server.
- The “prisma” directory indicates usage of Prisma with multiple migration folders, a schema file, seed files, etc., which shows that the API depends heavily on a robust database layer.
- “tasks” holds files for scheduled operations (node cron tasks and email sending), indicating background job processing.
- “assets” is used for storing uploaded images or files, supporting the API’s file management functionalities.

##### README for Additional Insights
- The README emphasizes that this is a local API for managing clinic data and outlines the technologies used (JavaScript, Node.js, Prisma, MySQL, Node Cron, and Nodemailer).
- It confirms the modularity and clear separation between models, controllers, routes, and services. It also points out that file management (uploads) is a core feature.

a. API Server and Application Logic:
- Entry Point (app.js): Shows where the server starts and how middleware, routing, and controllers are integrated.
- Controllers: Each controller (e.g., usuarioController, facturaController) implements domain-specific business logic.
- Routes: Define the API endpoints and link client HTTP requests to the proper controller methods.
- Middleware: Includes authentication (auth.js) to protect endpoints and upload handling (upload.js) for image/file management.
b. Database Layer:
- Prisma & Migrations: Include the Prisma schema and all migration scripts that set up the MySQL database.
- MySQL Database: Represent the database itself, storing clinic-related data.
c. Static Assets and File Management:
- Assets Folder: Manages uploaded files and images for the clinic (e.g., evidences, profiles).
d. Background Tasks and Email Notifications:
- Tasks: Represent scheduled jobs (e.g., appointment reminders and sendEmail tasks) using Node Cron.
- Nodemailer: External email service integration for notifications.

##### Relationships and Interactions
- An external client (e.g., the frontend or mobile app) sends HTTP requests to the API server.
- The app.js file accepts these requests, passes them through middleware (for authentication and file handling), and forwards them to the correct route.
- Routes then trigger controller actions which implement the business logic and communicate with the MySQL database using Prisma.
- In parallel, background tasks (triggered by Node Cron) run predefined jobs, possibly sending out emails with Nodemailer.
- File uploads are directly managed and stored in the assets/uploads directory.

##### Important Architectural Patterns and Technologies
- MVC-like (Model-View-Controller equivalent) separation: While there isn’t a “view” as in a classic MVC framework, the separation between routes, controllers, and database operations (via Prisma) matches the pattern.
- Modular Architecture: Each area (users, invoices, reservations, etc.) is decoupled for easier maintenance and scalability.
- Use of ORM (Prisma) to abstract database interactions ensuring robust data handling.
- Background processing via cron tasks for scheduled notifications and operations.

##### Putting It All Together
- On the side, show a flow for file uploads that goes from API (through middleware) to the Assets directory.
- Also, illustrate how background tasks use Node Cron to trigger emails via Nodemailer.

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client (Mobile/Web)"]:::external
    Entry["app.js"]:::api
    Client -->|"HTTP_Request"| Entry

    subgraph "HTTP Pipeline"
        direction TB
        subgraph "Middleware Layer"
            AuthMW["Authentication Middleware"]:::middleware
            UploadMW["Upload Middleware"]:::middleware
        end
        Entry -->|"processes"| AuthMW
        AuthMW -->|"and_then"| UploadMW

        subgraph "Routes Layer"
            direction TB
            R1["Categoria Routes"]:::route
            R2["Estado Routes"]:::route
            R3["Factura Routes"]:::route
            R4["Factura Detalle Routes"]:::route
            R5["File Routes"]:::route
            R6["Horario Routes"]:::route
            R7["Producto Routes"]:::route
            R8["Reporte Routes"]:::route
            R9["Reserva Routes"]:::route
            R10["Rol Routes"]:::route
            R11["SendEmail Routes"]:::route
            R12["Servicio Routes"]:::route
            R13["Sucursal Routes"]:::route
            R14["Sucursal Horario Routes"]:::route
            R15["Usuario Routes"]:::route
        end
        UploadMW -->|"routes_to"| R1
        UploadMW -->|"routes_to"| R2
        UploadMW -->|"routes_to"| R3
        UploadMW -->|"routes_to"| R4
        UploadMW -->|"routes_to"| R5
        UploadMW -->|"routes_to"| R6
        UploadMW -->|"routes_to"| R7
        UploadMW -->|"routes_to"| R8
        UploadMW -->|"routes_to"| R9
        UploadMW -->|"routes_to"| R10
        UploadMW -->|"routes_to"| R11
        UploadMW -->|"routes_to"| R12
        UploadMW -->|"routes_to"| R13
        UploadMW -->|"routes_to"| R14
        UploadMW -->|"routes_to"| R15

        subgraph "Controllers Layer"
            direction TB
            C1["Categoria Controller"]:::controller
            C2["Estado Controller"]:::controller
            C3["Factura Controller"]:::controller
            C4["Reserva Controller"]:::controller
            C5["File Controller"]:::controller
            C6["Horario Controller"]:::controller
            C7["Producto Controller"]:::controller
            C8["Reporte Controller"]:::controller
            C9["Rol Controller"]:::controller
            C10["SendEmail Controller"]:::controller
            C11["Servicio Controller"]:::controller
            C12["Sucursal Controller"]:::controller
            C13["Sucursal Horario Controller"]:::controller
            C14["Usuario Controller"]:::controller
        end
        R1 --> C1
        R2 --> C2
        R3 --> C3
        R4 --> C4
        R5 --> C5
        R6 --> C6
        R7 --> C7
        R8 --> C8
        R9 --> C4
        R10 --> C9
        R11 --> C10
        R12 --> C11
        R13 --> C12
        R14 --> C13
        R15 --> C14

        subgraph "Database Layer"
            direction TB
            PO["Prisma ORM & Migrations"]:::db
            DB["MySQL Database"]:::db
        end
        C1 --> PO
        C2 --> PO
        C3 --> PO
        C4 --> PO
        C5 --> PO
        C6 --> PO
        C7 --> PO
        C8 --> PO
        C9 --> PO
        C10 --> PO
        C11 --> PO
        C12 --> PO
        C13 --> PO
        C14 --> PO
        PO --> DB

        Assets["Assets Folder"]:::static
        UploadMW ---|"stores_uploads"| Assets
    end

    subgraph "Background Tasks"
        direction TB
        T1["Scheduled Task (Node Cron)"]:::background
        T2["Email Notification Task"]:::background
        NE["Nodemailer Email Service"]:::external
    end
    Entry -->|"triggers_background"| T1
    Entry -->|"triggers_background"| T2
    T2 --> NE

    click Entry "https://github.com/jona712/api-petclinic/blob/main/app.js"
    click AuthMW "https://github.com/jona712/api-petclinic/blob/main/middleware/auth.js"
    click UploadMW "https://github.com/jona712/api-petclinic/blob/main/middleware/upload.js"
    
    click R1 "https://github.com/jona712/api-petclinic/blob/main/routes/categoriaRoutes.js"
    click R2 "https://github.com/jona712/api-petclinic/blob/main/routes/estadoRoutes.js"
    click R3 "https://github.com/jona712/api-petclinic/blob/main/routes/facturaRoutes.js"
    click R4 "https://github.com/jona712/api-petclinic/blob/main/routes/facturaDetalleRoutes.js"
    click R5 "https://github.com/jona712/api-petclinic/blob/main/routes/fileRoutes.js"
    click R6 "https://github.com/jona712/api-petclinic/blob/main/routes/horarioRoutes.js"
    click R7 "https://github.com/jona712/api-petclinic/blob/main/routes/productoRoutes.js"
    click R8 "https://github.com/jona712/api-petclinic/blob/main/routes/reporteRoutes.js"
    click R9 "https://github.com/jona712/api-petclinic/blob/main/routes/reservaRoutes.js"
    click R10 "https://github.com/jona712/api-petclinic/blob/main/routes/rolRoutes.js"
    click R11 "https://github.com/jona712/api-petclinic/blob/main/routes/sendEmailRoutes.js"
    click R12 "https://github.com/jona712/api-petclinic/blob/main/routes/servicioRoutes.js"
    click R13 "https://github.com/jona712/api-petclinic/blob/main/routes/sucursalRoutes.js"
    click R14 "https://github.com/jona712/api-petclinic/blob/main/routes/sucursalHorarioRoutes.js"
    click R15 "https://github.com/jona712/api-petclinic/blob/main/routes/usuarioRoutes.js"
    
    click C1 "https://github.com/jona712/api-petclinic/blob/main/controllers/categoriaController.js"
    click C2 "https://github.com/jona712/api-petclinic/blob/main/controllers/estadoController.js"
    click C3 "https://github.com/jona712/api-petclinic/blob/main/controllers/facturaController.js"
    click C4 "https://github.com/jona712/api-petclinic/blob/main/controllers/reservaController.js"
    click C5 "https://github.com/jona712/api-petclinic/blob/main/controllers/fileController.js"
    click C6 "https://github.com/jona712/api-petclinic/blob/main/controllers/horarioController.js"
    click C7 "https://github.com/jona712/api-petclinic/blob/main/controllers/productoController.js"
    click C8 "https://github.com/jona712/api-petclinic/blob/main/controllers/reporteController.js"
    click C9 "https://github.com/jona712/api-petclinic/blob/main/controllers/rolController.js"
    click C10 "https://github.com/jona712/api-petclinic/blob/main/controllers/sendEmailController.js"
    click C11 "https://github.com/jona712/api-petclinic/blob/main/controllers/servicioController.js"
    click C12 "https://github.com/jona712/api-petclinic/blob/main/controllers/sucursalController.js"
    click C13 "https://github.com/jona712/api-petclinic/blob/main/controllers/sucursalHorarioController.js"
    click C14 "https://github.com/jona712/api-petclinic/blob/main/controllers/usuarioController.js"

    click PO "https://github.com/jona712/api-petclinic/blob/main/prisma/schema.prisma"
    click DB "https://github.com/jona712/api-petclinic/tree/main/prisma/migrations"
    
    click Assets "https://github.com/jona712/api-petclinic/tree/main/assets"
    
    click T1 "https://github.com/jona712/api-petclinic/blob/main/tasks/recordatorioTask.js"
    click T2 "https://github.com/jona712/api-petclinic/blob/main/tasks/sendEmail.js"

    classDef api fill:#f9f,stroke:#333,stroke-width:2px;
    classDef middleware fill:#ccf,stroke:#333,stroke-width:2px;
    classDef route fill:#fcf,stroke:#333,stroke-width:2px;
    classDef controller fill:#cfc,stroke:#333,stroke-width:2px;
    classDef db fill:#ff9,stroke:#333,stroke-width:2px;
    classDef external fill:#f96,stroke:#333,stroke-width:2px;
    classDef background fill:#cff,stroke:#333,stroke-width:2px;
    classDef static fill:#9cf,stroke:#333,stroke-width:2px;
```
