# erik-egam/backend-sistema-academico architecture

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

- Interactive diagram: https://gitdiagram.com/erik-egam/backend-sistema-academico
- Repository: https://github.com/erik-egam/backend-sistema-academico

## Overview

##### Project type and purpose
- Project Type: Monolithic backend API
- Technology Stack: Python, FastAPI, MySQL (via a config module), JWT for auth
- Purpose: Provide role-based REST endpoints to manage users, programs, courses, semesters, enrollments and grades in an academic environment.

##### High-level architectural layers
- Presentation/API Layer (FastAPI routes)
- Business Logic/Service Layer (model “functions” modules)
- Data Access Layer (config.py + direct MySQL calls)
- Persistence Layer (MySQL database)

##### Main components
a. FastAPI Application (main.py)
b. Route Modules (“routes/”):
- usuarios.py (authentication, JWT issuance)
- admin.py (admin CRUD and assignments)
- estudiantes.py (student operations)
- profesores.py (professor operations)
c. Model Modules (“models/”):
- Entity Models (Pydantic schemas in Asignatura.py, Semestre.py, Programa.py, Notas.py, Usuario.py)
- Service Modules (Admin_functions.py, estudiantes_functions.py, profesor_functions.py)
- config.py (database connection factory)
d. External System: MySQL database (seeded via inserts_pruebas.txt)

##### Relationships & data flow
- Client → HTTP request to FastAPI → routed by main.py
- Route handler invokes service function in models/*.py
- Service function uses config.get_connection() → executes SQL against MySQL
- Raw DB result → Pydantic model validations/serializations → JSON response
- Authentication routes generate/validate JWT → used as bearer token in subsequent calls

##### Architectural patterns & principles
- Layered/Clean Architecture: separation of concerns between controllers (routes), business logic (service functions), and data access (config + raw SQL)
- Role-Based Access Control: enforced in route decorators or inside handler logic (e.g., JWT scopes, user role checks)
- Modular Design: one file per domain function (e.g., Admin_functions.py) and one route per actor
- Dependency Injection (FastAPI’s Depends) for auth and DB connections

##### Technologies & frameworks
- FastAPI for HTTP server, routing, dependency injection, OpenAPI docs
- Pydantic for data validation and serialization
- mysql-connector/python (or equivalent) for direct DB connections
- PyJWT (via FastAPI dependency) for token creation & validation
- CORS middleware (configured in main.py)

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client"]:::external

    subgraph "API Layer"
        Main["FastAPI Application\n(main.py)"]:::api
        subgraph "Route Modules"
            Usu["Usuarios\n(routes/usuarios.py)"]:::api
            AdmR["Admin\n(routes/admin.py)"]:::api
            EstR["Estudiantes\n(routes/estudiantes.py)"]:::api
            ProfR["Profesores\n(routes/profesores.py)"]:::api
        end
    end

    subgraph "Service Layer"
        AdmS["AdminFunctions\n(models/Admin_functions.py)"]:::service
        EstS["EstudiantesFunctions\n(models/estudiantes_functions.py)"]:::service
        ProfS["ProfesorFunctions\n(models/profesor_functions.py)"]:::service
    end

    subgraph "Data Models"
        Asign["Asignatura\n(models/Asignatura.py)"]:::model
        Sem["Semestre\n(models/Semestre.py)"]:::model
        Prog["Programa\n(models/Programa.py)"]:::model
        Notas["Notas\n(models/Notas.py)"]:::model
        UsuarioM["Usuario\n(models/Usuario.py)"]:::model
    end

    Config["DB Connector\n(models/config.py)"]:::config
    Seed["Seed Data\n(inserts_pruebas.txt)"]:::external
    DB[(MySQL Database)]:::db

    Client -->|"JSON request"| Main
    Main -->|"mount router"| Usu
    Main -->|"mount router"| AdmR
    Main -->|"mount router"| EstR
    Main -->|"mount router"| ProfR

    Usu -->|"calls DB connector"| Config
    AdmR -->|"calls service"| AdmS
    EstR -->|"calls service"| EstS
    ProfR -->|"calls service"| ProfS

    AdmS -->|"get_connection()"| Config
    EstS -->|"get_connection()"| Config
    ProfS -->|"get_connection()"| Config

    Config -->|"execute SQL"| DB
    Seed -->|"load seed data"| DB

    AdmS -->|"validate with Pydantic"| UsuarioM
    AdmS -->|"validate with Pydantic"| Prog
    EstS -->|"validate with Pydantic"| Notas
    ProfS -->|"validate with Pydantic"| Notas

    classDef api fill:#D0E8FF,stroke:#0366d6
    classDef service fill:#E6FFEA,stroke:#228B22
    classDef model fill:#FFF4E5,stroke:#FFA500,stroke-dasharray: 5 5
    classDef config fill:#F0E0FF,stroke:#800080
    classDef external fill:#F2F2F2,stroke:#666
    classDef db fill:#FFE0B2,stroke:#FF8C00

    click Main "https://github.com/erik-egam/backend-sistema-academico/blob/main/main.py"
    click Usu "https://github.com/erik-egam/backend-sistema-academico/blob/main/routes/usuarios.py"
    click AdmR "https://github.com/erik-egam/backend-sistema-academico/blob/main/routes/admin.py"
    click EstR "https://github.com/erik-egam/backend-sistema-academico/blob/main/routes/estudiantes.py"
    click ProfR "https://github.com/erik-egam/backend-sistema-academico/blob/main/routes/profesores.py"
    click AdmS "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Admin_functions.py"
    click EstS "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/estudiantes_functions.py"
    click ProfS "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/profesor_functions.py"
    click Asign "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Asignatura.py"
    click Sem "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Semestre.py"
    click Prog "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Programa.py"
    click Notas "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Notas.py"
    click UsuarioM "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/Usuario.py"
    click Config "https://github.com/erik-egam/backend-sistema-academico/blob/main/models/config.py"
    click Seed "https://github.com/erik-egam/backend-sistema-academico/blob/main/inserts_pruebas.txt"
```
