# vb-consulting/npgsqlrest architecture

> Architecture diagram of the GitHub repository vb-consulting/npgsqlrest, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vb-consulting/npgsqlrest
- Repository: https://github.com/vb-consulting/npgsqlrest

## Overview

##### Main Components

a) Core Components:
- NpgsqlRest Middleware (Central Component)
- PostgreSQL Database
- REST API Layer
- Client Applications

b) Plugin System:
- CRUD Source Plugin
- HTTP Files Plugin
- TypeScript Client Generator Plugin

**[Client Layer]**
- ↑↓
**[REST API Layer]**
- ↑↓
**[NpgsqlRest Middleware]**
- ↑↓
**[PostgreSQL Database]**

##### Component Details

- Auth Handler (from Auth/ directory)
- Parameter Parser
- Routine Source Manager
- Type Converters
- Middleware Extensions

Plugin System (Right side):
- CRUD Operations
- HTTP File Generation
- TypeScript Client Generation

Database Integration (Bottom):
- PostgreSQL connection with:
- Function/Procedure Discovery
- Comment Parser
- Type Mapping

Client Integration (Top):
- Supported client interfaces:
- REST API Endpoints
- Generated TypeScript Clients
- HTTP File Definitions

##### Flow Indicators

- Request flow from clients through the middleware to database
- Response flow back to clients
- Plugin integration points
- Code generation paths

##### Technical Details

Technical aspects:
- .NET 8/9 compatibility
- Npgsql integration
- PostgreSQL version requirements (≥13)
- Native AOT compilation support

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph CL["Client Layer"]
        REST["REST API Endpoints"]
        TSC["TypeScript Clients"]
        HTTP["HTTP Files"]
    end

    subgraph ML["Middleware Layer"]
        direction TB
        CORE["NpgsqlRest Middleware"]:::core
        click CORE "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/NpgsqlRestMiddleware.cs"
        
        subgraph AUTH["Authentication System"]
            AH["Auth Handler"]:::auth
            CD["Claims Dictionary"]:::auth
            AO["Auth Options"]:::auth
            click AH "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Auth/AuthHandler.cs"
            click CD "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Auth/ClaimsDictionary.cs"
            click AO "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/NpgsqlRestAuthenticationOptions.cs"
        end

        subgraph PARAM["Parameter Handling"]
            PP["Parameter Parser"]:::param
            NRP["Rest Parameter"]:::param
            PV["Parameter Validation"]:::param
            click PP "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/ParameterParser.cs"
            click NRP "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/NpgsqlRestParameter.cs"
            click PV "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/ParameterValidationValues.cs"
        end

        subgraph TYPES["Type System"]
            TC["Type Converters"]:::type
            TD["Type Descriptor"]:::type
            click TC "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/PgConverters.cs"
            click TD "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/TypeDescriptor.cs"
        end

        subgraph RSM["Routine Source Management"]
            R["Routine"]:::routine
            RE["Routine Endpoint"]:::routine
            RS["Routine Source"]:::routine
            RSQ["Routine Source Query"]:::routine
            click R "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Routine.cs"
            click RE "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/RoutineEndpoint.cs"
            click RS "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/RoutineSource.cs"
            click RSQ "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/RoutineSourceQuery.cs"
        end

        subgraph DEF["Default Components"]
            DCP["Comment Parser"]:::default
            DE["Default Endpoint"]:::default
            DNC["Name Converter"]:::default
            DUB["URL Builder"]:::default
            click DCP "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Defaults/DefaultCommentParser.cs"
            click DE "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Defaults/DefaultEndpoint.cs"
            click DNC "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Defaults/DefaultNameConverter.cs"
            click DUB "https://github.com/vb-consulting/NpgsqlRest/blob/master/NpgsqlRest/Defaults/DefaultUrlBuilder.cs"
        end
    end

    subgraph PL["Plugin System"]
        CRUD["CRUD Source Plugin"]:::plugin
        HTTPF["HTTP Files Plugin"]:::plugin
        TSG["TypeScript Client Generator"]:::plugin
        click CRUD "https://github.com/vb-consulting/NpgsqlRest/tree/master/plugins/NpgsqlRest.CrudSource/"
        click HTTPF "https://github.com/vb-consulting/NpgsqlRest/tree/master/plugins/NpgsqlRest.HttpFiles/"
        click TSG "https://github.com/vb-consulting/NpgsqlRest/tree/master/plugins/NpgsqlRest.TsClient/"
    end

    subgraph DB["Database Layer"]
        PG[(PostgreSQL)]
    end

    %% Connections
    CL --> CORE
    CORE --> PG
    CORE --> PL
    
    %% Plugin connections
    CRUD --> PG
    HTTPF --> HTTP
    TSG --> TSC

    %% Styles
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef auth fill:#e74c3c,stroke:#c0392b,color:white
    classDef param fill:#2ecc71,stroke:#27ae60,color:white
    classDef type fill:#9b59b6,stroke:#8e44ad,color:white
    classDef routine fill:#f1c40f,stroke:#f39c12,color:black
    classDef default fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef plugin fill:#e67e22,stroke:#d35400,color:white
```
