# briansittmann/caloria-backend architecture

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

- Interactive diagram: https://gitdiagram.com/briansittmann/caloria-backend
- Repository: https://github.com/briansittmann/caloria-backend

## Overview

##### Project type and purpose
- This is a monolithic Java backend service (Spring Boot) that exposes RESTful APIs for a nutritional coaching application (“CalorIA Backend”).
- It handles user registration/authentication, user profile goals, daily food logging, recipe catalog, and macro-nutrient calculations. It persists data in MongoDB and will call an external AI service (OpenAI) for food analysis.

##### File structure
- Top-level: pom.xml, mvnw, README.md, token.txt
- src/main/java/com/caloria:
- config: Spring configuration classes (Jackson, Security, Swagger, OkHttpClient, JWT filter)
- controller: REST controllers (AuthController, ComidaController, DiaController, PerfilController, RecetaController)
- dto: Data Transfer Objects for requests/responses
- model: Domain entities (Usuario, Receta, Alimento, Dia, etc.)
- repository: Spring Data MongoDB repositories
- service: Business logic (AuthService, UsuarioService, DiaService, Catalogo services, CaloriasCalculator, JwtService, IAService)
- utils: supporting utilities (RoundingUtils)
- src/main/resources/application.properties: app configuration
- Testing under src/test/java

##### README for additional insights
- Tech stack: Java 11+, Spring Boot, MongoDB, Lombok, Maven, upcoming OpenAI integration
- No frontend—focus entirely on backend API

a. Components
1. API Layer – Spring MVC Controllers
2. Security Layer – SecurityConfig + JwtAuthenticationFilter
3. Service Layer – business services (AuthService, UsuarioService, DiaService, IAService, etc.)
4. Data Access Layer – Spring Data Repositories
5. Database – MongoDB instance/cluster
6. External Service – OpenAI API (via OkHttpClient)
7. Configuration Modules – JacksonConfig, SwaggerConfig
b. Relationships & Data Flow
- Incoming HTTP request → SecurityFilter → Controller → Service → Repository → MongoDB
- Service IAService → OkHttpClient → OpenAI API → DTO response → Controller → Client
- Controllers return JSON; JacksonConfig handles serialization
- SwaggerConfig exposes /swagger-ui for API docs
c. Architectural patterns/design principles
- Layered architecture (Controller → Service → Repository)
- Separation of concerns: DTO vs. domain model
- JWT-based stateless authentication
- External API integration via client config
d. Key technologies/frameworks
- Spring Boot (web, security, data-mongodb)
- Spring Security + JWT
- Spring Data MongoDB
- Swagger (Springfox)
- OkHttp client
- Lombok (code generation)

##### Essential architectural elements to capture
- The security filter chain (JwtAuthenticationFilter) sitting before controllers
- The separation of DTOs vs. domain models
- The CaloriasCalculator and IAService under “Business Logic”
- The fact that all data persistence uses MongoDB
- The Swagger UI endpoint as part of the API module

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Security Layer
    subgraph "Security Layer"
        SC[“SecurityConfig”]:::config
        JF[“JwtAuthenticationFilter”]:::config
        JS[“JwtService”]:::service
    end

    %% API Layer
    subgraph "API Layer"
        AC[“AuthController”]:::api
        CC[“ComidaController”]:::api
        DC[“DiaController”]:::api
        PC[“PerfilController”]:::api
        RC[“RecetaController”]:::api
    end

    %% Service Layer
    subgraph "Business Logic Layer"
        AS[“AuthService”]:::service
        US[“UsuarioService”]:::service
        DS[“DiaService”]:::service
        CAS[“CatalogoAlimentoService”]:::service
        CRS[“CatalogoRecetasService”]:::service
        CreS[“CredencialService”]:::service
        MS[“MetabolismoService”]:::service
        PS[“PerfilService”]:::service
        CCa[“CaloriasCalculator”]:::service
        IAS[“IAService”]:::service
    end

    %% Persistence Layer
    subgraph "Persistence Layer"
        UR[“UsuarioRepository”]:::repo
        CR[“CredencialRepository”]:::repo
        CAR[“CatalogoAlimentoRepository”]:::repo
        CRR[“CatalogoRecetasRepository”]:::repo
        MDB[(“MongoDB”)]:::db
    end

    %% Configuration Modules
    subgraph "Configuration Modules"
        JC[“JacksonConfig”]:::config
        SCfg[“SwaggerConfig”]:::config
        OC[“OkHttpClientConfig”]:::config
    end

    %% External Service
    subgraph "External Integration"
        OAI[(“OpenAI API”)]:::external
    end

    %% Application Entry & DTO/Model
    CB[“CaloriaBackendApplication”]:::config
    APP[“application.properties”]:::config

    %% Flow arrows
    HTTP[“HTTP Request”]:::external -->|“secure”| JF
    JF --> AC
    JF --> CC
    JF --> DC
    JF --> PC
    JF --> RC

    AC -->|“calls”| AS
    CC -->|“calls”| CAS
    DC -->|“calls”| DS
    PC -->|“calls”| PS
    RC -->|“calls”| CRS

    AS --> UR
    US --> UR
    DS --> UR
    CAS --> CAR
    CRS --> CRR
    CreS --> CR
    PS --> UR

    AnyService[(“Any Service”)]

    IAS -->|“HTTP”| OAI
    CCa -->|“calc”| DS

    UR -->|“reads/writes”| MDB
    CAR -->|“reads/writes”| MDB
    CRR -->|“reads/writes”| MDB
    CR -->|“reads/writes”| MDB

    %% Config coupling
    JC --> AC
    SCfg --> HTTP
    OC --> IAS

    %% Entry point
    CB -->|“starts”| AC
    CB -->|“loads config”| APP

    %% Click Events
    click SC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/config/SecurityConfig.java"
    click JF "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/config/JwtAuthenticationFilter.java"
    click JS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/JwtService.java"
    click AC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/controller/AuthController.java"
    click CC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/controller/ComidaController.java"
    click DC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/controller/DiaController.java"
    click PC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/controller/PerfilController.java"
    click RC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/controller/RecetaController.java"
    click JC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/config/JacksonConfig.java"
    click SCfg "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/config/SwaggerConfig.java"
    click OC "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/config/OkHttpClientConfig.java"
    click IAS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/IAService.java"
    click AS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/AuthService.java"
    click US "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/UsuarioService.java"
    click DS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/DiaService.java"
    click CAS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/CatalogoAlimentoService.java"
    click CRS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/CatalogoRecetasService.java"
    click CreS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/CredencialService.java"
    click MS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/MetabolismoService.java"
    click PS "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/PerfilService.java"
    click CCa "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/service/CaloriasCalculator.java"
    click UR "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/repository/UsuarioRepository.java"
    click CR "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/repository/CredencialRepository.java"
    click CAR "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/repository/CatalogoAlimentoRepository.java"
    click CRR "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/repository/CatalogoRecetasRepository.java"
    click CB "https://github.com/briansittmann/caloria-backend/blob/master/src/main/java/com/caloria/CaloriaBackendApplication.java"
    click APP "https://github.com/briansittmann/caloria-backend/blob/master/src/main/resources/application.properties"

    %% Styles
    classDef api fill:#D0E6F6,stroke:#036;
    classDef service fill:#D5F6C1,stroke:#0A6;
    classDef repo fill:#FDE7C2,stroke:#F80;
    classDef db fill:#F6D0D0,stroke:#600;
    classDef external fill:#D3D3D3,stroke:#888;
    classDef config fill:#E0D0F6,stroke:#60F;
```
