# validraganescu/openapi-router architecture

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

- Interactive diagram: https://gitdiagram.com/validraganescu/openapi-router
- Repository: https://github.com/validraganescu/openapi-router

## Overview

##### Main Components

a) Core Router System:
- Router Singleton (from src/router/router.ts)
- To Request Handler (src/router/request-handler.ts)
- Connection to Lambda Router integration (src/router/lambda-router.ts)

b) Metadata Management System:
- Connections to decorators (@DocMetadata and @Route)
- Relationship with model metadata, method metadata, and route metadata

c) Documentation Generation System:
- API Documentation Generator component
- Connections to OpenAPI 3.0 spec output
- To metadata storage system

d) Validation System:
- Validator component
- Connections to request/response validation flow
- To metadata system for schema validation

e) Middleware System:
- Both global and route-specific middleware handlers
- Before/after middleware flow
- To the main request processing pipeline

##### Component Relationships and Data Flow

**Request → Global Before Middleware → Route Before Middleware → Handler → Route After Middleware → Global After Middleware → Response**

##### Specific Implementation Details

- Request<T>
- Response<T>
- Router
- MetadataStorage
- ApiDocGenerator
- Validator
- MiddlewareHandler

##### Important Architectural Patterns to Highlight

- Decorator Pattern: Show how @DocMetadata and @Route decorators interact
- Singleton Pattern: Highlight Router instance
- Middleware Chain: Demonstrate the middleware execution flow
- Metadata Repository: Show centralized metadata storage

##### External Integration Points

- Lambda integration point
- OpenAPI 3.0 documentation output
- HTTP request/response interfaces

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Router System"]
        Router["Router Singleton"]:::core
        ReqHandler["Request Handler"]:::core
        LambdaRouter["Lambda Router"]:::core
        Request["Request<T>"]:::core
        Response["Response<T>"]:::core
        DevServer["Dev Server"]:::core
    end

    subgraph Meta["Metadata Management"]
        MetaStorage["Metadata Storage"]:::meta
        RouteMetadata["Route Metadata"]:::meta
        MethodMetadata["Method Metadata"]:::meta
        ModelMetadata["Model Metadata"]:::meta
        RouterMetadata["Router Metadata"]:::meta
    end

    subgraph Doc["Documentation Generation"]
        DocGen["API Doc Generator"]:::doc
        DocDecorators["Doc Decorators"]:::doc
        OpenAPIModels["OpenAPI Models"]:::doc
    end

    subgraph Val["Validation System"]
        Validator["Validator"]:::validator
    end

    subgraph Mid["Middleware System"]
        GlobalMid["Global Middleware"]:::middleware
        RouteMid["Route Middleware"]:::middleware
        AuthMid["Auth Middleware"]:::middleware
        ThrowMid["Throw Middleware"]:::middleware
    end

    subgraph Dec["Route Decoration"]
        RouteDecorators["Route Decorators"]:::decorator
        APIRouterDec["API Router Decorator"]:::decorator
    end

    subgraph Err["Error Handling"]
        APIError["API Error"]:::error
        StatusCodes["Status Codes"]:::error
    end

    subgraph Mock["Mock System"]
        MockResponse["Mock Response"]:::mock
        RandomGen["Random Generator"]:::mock
    end

    %% Relationships
    Router --> ReqHandler
    Router --> LambdaRouter
    Router --> Request
    Router --> Response
    Router --> DevServer

    MetaStorage --> RouteMetadata
    MetaStorage --> MethodMetadata
    MetaStorage --> ModelMetadata
    MetaStorage --> RouterMetadata

    DocGen --> OpenAPIModels
    DocGen --> DocDecorators
    DocGen --> MetaStorage

    Router --> Validator
    Validator --> MetaStorage

    Router --> GlobalMid
    Router --> RouteMid
    GlobalMid --> AuthMid
    GlobalMid --> ThrowMid

    Router --> RouteDecorators
    Router --> APIRouterDec

    Router --> APIError
    APIError --> StatusCodes

    DevServer --> MockResponse
    MockResponse --> RandomGen

    %% Click Events
    click Router "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/router.ts"
    click ReqHandler "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/request-handler.ts"
    click LambdaRouter "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/lambda-router.ts"
    click Request "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/request.ts"
    click Response "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/response.ts"
    click DevServer "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/dev-server.ts"
    
    click MetaStorage "https://github.com/ValiDraganescu/openapi-router/blob/master/src/metadata/metadata-storage.ts"
    click RouteMetadata "https://github.com/ValiDraganescu/openapi-router/blob/master/src/metadata/route-metadata.ts"
    click MethodMetadata "https://github.com/ValiDraganescu/openapi-router/blob/master/src/metadata/method-metadata.ts"
    click ModelMetadata "https://github.com/ValiDraganescu/openapi-router/blob/master/src/metadata/model-metadata.ts"
    click RouterMetadata "https://github.com/ValiDraganescu/openapi-router/blob/master/src/metadata/router-metadata.ts"
    
    click DocGen "https://github.com/ValiDraganescu/openapi-router/blob/master/src/doc/generator.ts"
    click DocDecorators "https://github.com/ValiDraganescu/openapi-router/blob/master/src/doc/decorators/doc.ts"
    click OpenAPIModels "https://github.com/ValiDraganescu/openapi-router/tree/master/src/doc/model"
    
    click Validator "https://github.com/ValiDraganescu/openapi-router/blob/master/src/validator/validator.ts"
    
    click AuthMid "https://github.com/ValiDraganescu/openapi-router/blob/master/example/middleware/auth-middleware.ts"
    click ThrowMid "https://github.com/ValiDraganescu/openapi-router/blob/master/example/middleware/throw-middleware.ts"
    
    click RouteDecorators "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/decorators/route.ts"
    click APIRouterDec "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/decorators/api-router.ts"
    
    click APIError "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/api-error.ts"
    click StatusCodes "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/status-code.ts"
    
    click MockResponse "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/mock/get-mock-response.ts"
    click RandomGen "https://github.com/ValiDraganescu/openapi-router/blob/master/src/router/mock/get-random.ts"

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef meta fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef doc fill:#4CAF50,stroke:#388E3C,color:white
    classDef validator fill:#FFC107,stroke:#FFA000,color:black
    classDef middleware fill:#FF9800,stroke:#F57C00,color:white
    classDef decorator fill:#00BCD4,stroke:#0097A7,color:white
    classDef error fill:#F44336,stroke:#D32F2F,color:white
    classDef mock fill:#795548,stroke:#5D4037,color:white
```
