# hrmilon/ticket-api-laravel architecture

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

- Interactive diagram: https://gitdiagram.com/hrmilon/ticket-api-laravel
- Repository: https://github.com/hrmilon/ticket-api-laravel

## Overview

##### Main Components Identification

The system is a RESTful API service with the following key components:

a. Authentication Layer
- Token-based authentication using Laravel Sanctum
- Login/Logout functionality
- Protected routes (marked with 🔒)

b. API Layer (Versioned - V1)
- Controllers for different resources (Tickets, Users, Authors)
- Request validation
- Resource transformation
- Custom filtering system

c. Data Layer
- Database models (User, Ticket)
- Migrations and seeders
- Relationships between models

d. Authorization Layer
- Policies for access control
- Custom abilities definitions

**┌─────────────────────────────────────────────────────────┐**
- Client Applications                   │
- ┘
- ↕ HTTPS
**┌─────────────────────────────────────────────────────────┐**
- API Gateway Layer                     │
- ┌─────────────┐    ┌──────────────┐   ┌────────────┐  │
- Routes    │ -> │  Middleware  │ -> │   Auth     │  │
- ┘    └──────────────┘   └────────────┘  │
- ┘
- ↕
**┌─────────────────────────────────────────────────────────┐**
- Application Layer                      │
- ┌─────────────┐    ┌──────────────┐   ┌────────────┐  │
- Controllers │ -> │   Requests   │ -> │ Resources  │  │
- ┘    └──────────────┘   └────────────┘  │
- ┌─────────────┐    ┌──────────────┐                   │
- Policies   │ <- │   Filters    │                   │
- ┘    └──────────────┘                   │
- ┘
- ↕
**┌─────────────────────────────────────────────────────────┐**
- Data Layer                          │
- ┌─────────────┐    ┌──────────────┐   ┌────────────┐  │
- Models    │ <- │  Migrations  │   │  Seeders   │  │
- ┘    └──────────────┘   └────────────┘  │
- ┘
- ↕
**┌─────────────────────────────────────────────────────────┐**
- Database                            │
- ┘

##### Important Relationships to Highlight

a. Resource Relationships:
- User (Author) -> Tickets (one-to-many)
- Relationship between models

b. Authentication Flow:
- Client -> Auth Controller -> Sanctum -> Token
- Protected routes validation flow

c. Request Processing Pipeline:
- Route -> Middleware -> Controller -> Resource -> Response

##### Additional Elements

a. API Versioning:
- V1 namespace separation
- Potential for future versions

b. Filtering System:
- Custom filter implementation
- QueryFilter base class
- Specific filters (AuthorFilter, TicketFilter)

c. Error Handling:
- Custom error responses
- Exception handling flow

##### Notes for Implementation

- Keep the main flow clear and centered
- Related components together
- Clear boundaries between layers
- Notes about authentication requirements
- RESTful nature of the API

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        CA[Client Applications]:::client
    end

    subgraph Gateway
        RT["Routes"]:::gateway
        MW["Middleware"]:::gateway
        AU["Authentication"]:::security
        RT --> MW --> AU
    end

    subgraph API
        direction TB
        AC["API Controllers"]:::api
        TC["Ticket Controller"]:::api
        UC["User Controller"]:::api
        AUC["Authors Controller"]:::api
        AC --> TC & UC & AUC
    end

    subgraph Validation
        RV["Request Validation"]:::validation
        BT["Base Ticket Request"]:::validation
        BU["Base User Request"]:::validation
        ST["Store Ticket Request"]:::validation
        SU["Store User Request"]:::validation
        RV --> BT & BU
        BT --> ST
        BU --> SU
    end

    subgraph Resources
        RT["Resource Transformation"]:::resource
        TR["Ticket Resource"]:::resource
        UR["User Resource"]:::resource
        RT --> TR & UR
    end

    subgraph Authorization
        PL["Policies"]:::security
        TP["Ticket Policy"]:::security
        UP["User Policy"]:::security
        AB["Abilities"]:::security
        PL --> TP & UP
        TP & UP --> AB
    end

    subgraph Filters
        FS["Filtering System"]:::filter
        QF["Query Filter"]:::filter
        AF["Author Filter"]:::filter
        TF["Ticket Filter"]:::filter
        FS --> QF
        QF --> AF & TF
    end

    subgraph Data
        DL["Data Layer"]:::data
        TM["Ticket Model"]:::data
        UM["User Model"]:::data
        MG["Migrations"]:::data
        SD["Seeders"]:::data
        DL --> TM & UM
        DL --> MG & SD
    end

    subgraph Error
        EH["Error Handling"]:::error
        CR["Custom Render"]:::error
        ERH["Error Response Handler"]:::error
        EH --> CR & ERH
    end

    subgraph Database
        DB[(Database)]:::database
    end

    CA <--> RT
    AU --> AC
    AC --> RV
    RV --> RT
    AC --> PL
    AC --> FS
    DL --> DB

    %% Component Mappings
    click AU "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Controllers/Api/AuthController.php"
    click TC "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Controllers/Api/V1/TicketController.php"
    click UC "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Controllers/Api/V1/UserController.php"
    click AUC "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Controllers/Api/V1/AuthorsController.php"
    click BT "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Requests/Api/V1/BaseTicketRequest.php"
    click BU "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Requests/Api/V1/BaseUserRequest.php"
    click ST "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Requests/Api/V1/StoreTicketRequest.php"
    click SU "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Requests/Api/V1/StoreUserRequest.php"
    click TR "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Resources/V1/TicketResource.php"
    click UR "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Resources/V1/UserResource.php"
    click TM "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Models/Ticket.php"
    click UM "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Models/User.php"
    click TP "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Policies/V1/TicketPolicy.php"
    click UP "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Policies/V1/UserPolicy.php"
    click AB "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Permissions/V1/Abilities.php"
    click QF "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Filters/V1/QueryFilter.php"
    click AF "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Filters/V1/AuthorFilter.php"
    click TF "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Http/Filters/V1/TicketFilter.php"
    click RT "https://github.com/hrmilon/ticket-api-laravel/blob/main/routes/api.php"
    click CR "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Exceptions/CustomRender.php"
    click ERH "https://github.com/hrmilon/ticket-api-laravel/blob/main/app/Exceptions/ErrorResponseHandler.php"

    %% Styles
    classDef client fill:#2374ab
    classDef gateway fill:#57886C
    classDef api fill:#88D498
    classDef validation fill:#F2E394
    classDef resource fill:#F2AE72
    classDef security fill:#F26B5E
    classDef filter fill:#D94F70
    classDef data fill:#8C271E
    classDef error fill:#4C1C00
    classDef database fill:#2F242C
```
