# nisrinelr/task_rbac architecture

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

- Interactive diagram: https://gitdiagram.com/nisrinelr/task_rbac
- Repository: https://github.com/nisrinelr/task_rbac

## Overview

##### Project Type and Purpose
- This is a Laravel-based RESTful API (“Task App RBAC API”) that provides user registration/login, role-based access control (RBAC) for admins and users, and CRUD operations on tasks. It leverages Laravel Sanctum for token-based authentication and L5-Swagger for interactive API documentation.

##### File Structure Analysis
- Top-level directories:
- app/ (MVC: Controllers, Models, Middleware, Console, Exceptions, Providers)
- config/ (configuration for auth, database, cache, swagger, etc.)
- database/ (migrations, seeders, factories)
- public/ (web entry point index.php, assets)
- resources/ (static assets, blade views – minimal since API only)
- routes/ (api.php, web.php, etc.)
- tests/ (Feature and Unit tests)
- MVC pattern with clear separation of concerns.
- Sanctum and Middleware for authentication and RBAC (RoleMiddleware).
- Swagger docs in storage/api-docs.

##### Key Components
a. External Clients
- API consumers (web clients, Postman, frontend JS apps)
- Swagger UI (interactive API docs)
b. API Gateway / Web Server
- Nginx/Apache (or PHP built-in server via `php artisan serve`)
- Entry point: public/index.php → bootstrap/app.php
c. Laravel HTTP Kernel & Middleware
- Global middleware (e.g., TrimStrings, TrustProxies)
- Route middleware (Authenticate, VerifyCsrfToken, RoleMiddleware)
d. Routing Layer
- routes/api.php defines endpoints (/api/register, /api/login, /api/tasks, etc.)
e. Controllers
- AuthController (register, login, me)
- TasksController (CRUD operations with RBAC checks)
f. Services / Business Logic
- Eloquent Models (User, Task)
- Policies or Middleware enforcing roles
g. Persistence
- Database (SQLite/MySQL) with tables: users, tasks, personal_access_tokens, etc.
- Migrations & Seeders provision schema and initial data
h. Authentication & Token Management
- Laravel Sanctum issues and validates tokens
i. API Documentation
- L5-Swagger reads annotations and serves Swagger UI at /api/documentation

##### Interactions and Data Flow
1. Client → Web Server: HTTP(S) request
2. Web Server → public/index.php → Laravel Kernel
3. Kernel → Global & Route Middleware (Auth, Role checks)
4. Middleware → Routing resolves Controller
5. Controller → Model (via Eloquent) → Database
6. Database → Eloquent → Controller → JSON response
7. Client receives response or Swagger UI displays docs

##### Architectural Patterns & Principles
- MVC (Model-View-Controller) – though “View” is minimal for an API
- Layered Architecture: Presentation (HTTP/API) → Application (Controllers/Middleware) → Domain (Models/Policies) → Infrastructure (DB)
- RBAC via middleware for separation of security concerns
- Configuration-as-code (config/ directory)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "External Clients"
        Client["HTTP Clients (Postman/JS)"]:::external
        Swagger["Swagger UI"]:::external
    end
    Client -->|"HTTP Request"| WebServer
    Swagger -->|"Fetch Docs"| WebServer

    subgraph "Web Server & Bootstrap"
        WebServer["Web Server\n(public/index.php)"]:::api
        Bootstrap["bootstrap/app.php"]:::api
    end
    WebServer --> Bootstrap
    Bootstrap --> Kernel

    Kernel["HTTP Kernel\n(app/Http/Kernel.php)"]:::logic

    subgraph "Middleware Layer"
        Trim["TrimStrings"]:::logic
        Trust["TrustProxies"]:::logic
        Verify["VerifyCsrfToken"]:::logic
        Auth["Authenticate"]:::logic
        Role["RoleMiddleware"]:::logic
    end
    Kernel --> Trim
    Kernel --> Trust
    Kernel --> Verify
    Kernel --> Auth
    Auth --> Role
    Role --> Router

    Router["Router\n(routes/api.php)"]:::api
    Kernel --> Router

    subgraph "Controllers"
        AuthController["AuthController"]:::logic
        TasksController["TasksController"]:::logic
    end
    Router --> AuthController
    Router --> TasksController

    subgraph "Models"
        UserModel["User Model"]:::data
        TaskModel["Task Model"]:::data
    end
    AuthController --> UserModel
    TasksController --> TaskModel

    subgraph "Database & Persistence"
        DB[(Database)]:::data
        Migrations["Migrations & Seeders"]:::data
    end
    UserModel --> DB
    TaskModel --> DB
    Migrations --> DB

    subgraph "Configuration"
        ConfigApp["config/app.php"]:::config
        ConfigAuth["config/auth.php"]:::config
        ConfigSanctum["config/sanctum.php"]:::config
        ConfigSwagger["config/l5-swagger.php"]:::config
    end
    ConfigApp --> Kernel
    ConfigAuth --> Auth
    ConfigSanctum --> Auth
    ConfigSwagger --> Swagger

    classDef external fill:#dddddd,stroke:#999;
    classDef api fill:#bbdefb,stroke:#1e88e5;
    classDef logic fill:#c8e6c9,stroke:#388e3c;
    classDef data fill:#ffe0b2,stroke:#f57c00;
    classDef config fill:#e1bee7,stroke:#8e24aa;

    click Swagger "https://github.com/nisrinelr/task_rbac/blob/main/config/l5-swagger.php"
    click WebServer "https://github.com/nisrinelr/task_rbac/blob/main/public/index.php"
    click Bootstrap "https://github.com/nisrinelr/task_rbac/blob/main/bootstrap/app.php"
    click Kernel "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Kernel.php"
    click Trim "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Middleware/TrimStrings.php"
    click Trust "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Middleware/TrustProxies.php"
    click Verify "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Middleware/VerifyCsrfToken.php"
    click Auth "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Middleware/Authenticate.php"
    click Role "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Middleware/RoleMiddleware.php"
    click Router "https://github.com/nisrinelr/task_rbac/blob/main/routes/api.php"
    click AuthController "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Controllers/AuthController.php"
    click TasksController "https://github.com/nisrinelr/task_rbac/blob/main/app/Http/Controllers/TasksController.php"
    click UserModel "https://github.com/nisrinelr/task_rbac/blob/main/app/Models/User.php"
    click TaskModel "https://github.com/nisrinelr/task_rbac/blob/main/app/Models/Task.php"
    click ConfigApp "https://github.com/nisrinelr/task_rbac/blob/main/config/app.php"
    click ConfigAuth "https://github.com/nisrinelr/task_rbac/blob/main/config/auth.php"
    click ConfigSanctum "https://github.com/nisrinelr/task_rbac/blob/main/config/sanctum.php"
    click ConfigSwagger "https://github.com/nisrinelr/task_rbac/blob/main/config/l5-swagger.php"
```
