# emerss001/api-bibliotech architecture

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

- Interactive diagram: https://gitdiagram.com/emerss001/api-bibliotech
- Repository: https://github.com/emerss001/api-bibliotech

## Overview

##### Project type and purpose
- This is a standalone Java‐based RESTful API (“api-bibliotec”) that exposes endpoints for managing a virtual library (users, materials, loans, evaluations).
- It follows a layered architecture (Controller → Service → DAO → Database) and uses MySQL (via Docker Compose) plus Firebase for media storage and JWT for authentication.

##### File structure
Top‐level:
- Server.java – application entrypoint, sets up the HTTP server & routes
- docker-compose.yml – spins up MySQL
- pom.xml – Maven dependencies (Spark/Spring, MySQL, Firebase SDK, JWT libs)
src/controller/ – REST controllers (AuthController, PessoaController, CatalogoController, etc.)
src/service/    – business logic services matching each controller
src/dao/        – data access objects interacting with DB
src/db/         – DB connection (ConnectionDB) + SQL migrations
src/dto/        – request/response payloads
src/entity/     – JPA‐style domain models (Pessoa, Material, Emprestimo, etc.)
src/util/       – helpers (FirebaseInitializer, FirebaseUpload, TokenUtil)
src/exception/  – custom exceptions

##### README highlights
- Java 24, Maven, Docker Compose (MySQL)
- Endpoints for user CRUD, login, material catalog, evaluations, loans
- No built‐in frontend – purely backend microservice/API

##### Core components
a. Client (e.g., Web or Mobile app)
b. API Server (Server.java)
– HTTP Router & Authentication Filter (TokenUtil)
– Controllers (AuthController, PessoaController, …)
c. Service Layer
– AuthService, PessoaService, MaterialService, …
– Orchestrates business rules & calls DAOs or util (FirebaseUpload)
d. Persistence Layer
– DAOs (AvaliacaoDAO, EmprestimoDAO, …)
– ConnectionDB → MySQL (container)
– DB Migrations (src/db/migrations)
e. External Services
– Firebase Storage (initialized via FirebaseInitializer)

##### Relationships and data flow
- Client → HTTP → Server (port 8888)
- Server → Controller (route matching)
- Controller → Service (pass validated DTO)
- Service → DAO (CRUD operations via JDBC/MySQL)
- DAO → MySQL Container
- Service → FirebaseUpload (for digital material files)
- TokenUtil ↔ Controllers (to issue/validate JWT tokens)

##### Architectural patterns & principles
- Layered Architecture (Presentation / Business / Data)
- DTO Pattern (to decouple domain entities from API models)
- DAO Pattern (for persistence isolation)
- Single Responsibility per layer/component

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client["Client (Web/Mobile)"]:::external

    %% API Server and Config
    APIServer["API Server\n(Server.java)"]:::http
    click APIServer "https://github.com/emerss001/api-bibliotech/blob/main/src/Server.java"
    Pom["Maven & Dependencies\n(pom.xml)"]:::util
    click Pom "https://github.com/emerss001/api-bibliotech/blob/main/pom.xml"
    DockerCompose["MySQL Container\n(docker-compose.yml)"]:::persistence
    click DockerCompose "https://github.com/emerss001/api-bibliotech/blob/main/docker-compose.yml"

    %% Controllers Layer
    subgraph "Controllers (HTTP Layer)"
        direction TB
        AuthController["AuthController"]:::http
        click AuthController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/AuthController.java"
        PessoaController["PessoaController"]:::http
        click PessoaController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/PessoaController.java"
        CatalogoController["CatalogoController"]:::http
        click CatalogoController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/CatalogoController.java"
        MaterialController["MaterialController"]:::http
        click MaterialController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/MaterialController.java"
        EmprestimoController["EmprestimoController"]:::http
        click EmprestimoController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/EmprestimoController.java"
        AvaliacaoController["AvaliacaoController"]:::http
        click AvaliacaoController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/AvaliacaoController.java"
        BibliotecarioController["BibliotecarioController"]:::http
        click BibliotecarioController "https://github.com/emerss001/api-bibliotech/blob/main/src/controller/BibliotecarioController.java"
    end

    %% Service Layer
    subgraph "Services (Business Logic)"
        direction TB
        AuthService["AuthService"]:::biz
        click AuthService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/AuthService.java"
        PessoaService["PessoaService"]:::biz
        click PessoaService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/PessoaService.java"
        CatalogoService["CatalogoService"]:::biz
        click CatalogoService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/CatalogoService.java"
        MaterialService["MaterialService"]:::biz
        click MaterialService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/MaterialService.java"
        EmprestimoService["EmprestimoService"]:::biz
        click EmprestimoService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/EmprestimoService.java"
        AvaliacaoService["AvaliacaoService"]:::biz
        click AvaliacaoService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/AvaliacaoService.java"
        BibliotecarioService["BibliotecarioService"]:::biz
        click BibliotecarioService "https://github.com/emerss001/api-bibliotech/blob/main/src/service/BibliotecarioService.java"
    end

    %% DAO Layer
    subgraph "DAOs (Persistence Layer)"
        direction TB
        PessoaDAO["PessoaDAO"]:::persistence
        click PessoaDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/PessoaDAO.java"
        CatalogoDAO["CatalogoDAO"]:::persistence
        click CatalogoDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/CatalogoDAO.java"
        MaterialDAO["MaterialDAO"]:::persistence
        click MaterialDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/MaterialDAO.java"
        EmprestimoDAO["EmprestimoDAO"]:::persistence
        click EmprestimoDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/EmprestimoDAO.java"
        AvaliacaoDAO["AvaliacaoDAO"]:::persistence
        click AvaliacaoDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/AvaliacaoDAO.java"
        BibliotecarioDAO["BibliotecarioDAO"]:::persistence
        click BibliotecarioDAO "https://github.com/emerss001/api-bibliotech/blob/main/src/dao/BibliotecarioDAO.java"
    end

    %% Database Connectivity & Migrations
    ConnectionDB["ConnectionDB"]:::util
    click ConnectionDB "https://github.com/emerss001/api-bibliotech/blob/main/src/db/ConnectionDB.java"
    Migrations["DB Migrations\n(src/db/migrations/)"]:::util
    click Migrations "https://github.com/emerss001/api-bibliotech/tree/main/src/db/migrations/"

    %% Utilities & External Integrations
    TokenUtil["TokenUtil\n(JWT)"]:::util
    click TokenUtil "https://github.com/emerss001/api-bibliotech/blob/main/src/util/TokenUtil.java"
    FirebaseInitializer["FirebaseInitializer"]:::util
    click FirebaseInitializer "https://github.com/emerss001/api-bibliotech/blob/main/src/util/FirebaseInitializer.java"
    FirebaseUpload["FirebaseUpload"]:::util
    click FirebaseUpload "https://github.com/emerss001/api-bibliotech/blob/main/src/util/FirebaseUpload.java"
    Firebase["Firebase Storage"]:::external

    %% Flow Definitions
    Client -->|"HTTP Request"| APIServer
    APIServer -->|"route match"| AuthController
    APIServer -->|"route match"| PessoaController
    APIServer -->|"route match"| CatalogoController
    APIServer -->|"route match"| MaterialController
    APIServer -->|"route match"| EmprestimoController
    APIServer -->|"route match"| AvaliacaoController
    APIServer -->|"route match"| BibliotecarioController

    AuthController -->|"calls"| AuthService
    PessoaController -->|"calls"| PessoaService
    CatalogoController -->|"calls"| CatalogoService
    MaterialController -->|"calls"| MaterialService
    EmprestimoController -->|"calls"| EmprestimoService
    AvaliacaoController -->|"calls"| AvaliacaoService
    BibliotecarioController -->|"calls"| BibliotecarioService

    AuthService -->|"uses DAO"| PessoaDAO
    PessoaService -->|"uses DAO"| PessoaDAO
    CatalogoService -->|"uses DAO"| CatalogoDAO
    MaterialService -->|"uses DAO"| MaterialDAO
    EmprestimoService -->|"uses DAO"| EmprestimoDAO
    AvaliacaoService -->|"uses DAO"| AvaliacaoDAO
    BibliotecarioService -->|"uses DAO"| BibliotecarioDAO

    PessoaDAO -->|"JDBC"| ConnectionDB
    CatalogoDAO -->|"JDBC"| ConnectionDB
    MaterialDAO -->|"JDBC"| ConnectionDB
    EmprestimoDAO -->|"JDBC"| ConnectionDB
    AvaliacaoDAO -->|"JDBC"| ConnectionDB
    BibliotecarioDAO -->|"JDBC"| ConnectionDB

    ConnectionDB -->|"connects to"| DockerCompose
    Migrations -->|"init schema"| DockerCompose

    ServiceLayerFirebase[MaterialService & others] --> FirebaseUpload
    FirebaseUpload -->|"upload"| Firebase
    FirebaseInitializer --> Firebase

    AuthController <-->|"validate/issue"| TokenUtil

    %% Group Pom
    APIServer --> Pom

    classDef http fill:#ADD8E6,stroke:#000;
    classDef biz fill:#90EE90,stroke:#000;
    classDef persistence fill:#FFA500,stroke:#000;
    classDef util fill:#D3D3D3,stroke:#000;
    classDef external fill:#DDEEFF,stroke:#000;
```
