# vitalik/django-ninja architecture

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

- Interactive diagram: https://gitdiagram.com/vitalik/django-ninja
- Repository: https://github.com/vitalik/django-ninja

## Overview

##### Main Components Identification

The system should be represented with these key components:

a) Core Framework Layer:
- API Request Handler (ninja/main.py)
- Router System (ninja/router.py)
- Security Components (ninja/security/)
- Schema Management (ninja/schema.py)
- Response Handling (ninja/responses.py)

b) Integration Layer:
- Django Integration
- ORM Integration (ninja/orm/)
- Authentication System

c) Documentation Layer:
- OpenAPI/Swagger Integration (ninja/openapi/)
- Interactive Documentation UI

##### Component Relationships

**[HTTP Request] → [Django URL Dispatcher]**
- ↓
**[Django Ninja Router] → [Operation Handler]**
- ↓
**[Request Validation] → [Schema Validation (Pydantic)]**
- ↓
**[Business Logic Execution]**
- ↓
**[Response Serialization] → [HTTP Response]**

##### Architectural Patterns to Highlight

- Rectangles: Core components
- Hexagons: External interfaces
- Rounded rectangles: Middleware components

##### Important Relationships

- How the API instance (NinjaAPI) connects to Django's URL configuration
- Security middleware chain
- Demonstrate the schema validation flow
- Documentation generation process

##### Implementation Details

- Async support capabilities
- Multiple authentication methods
- Schema validation and serialization
- OpenAPI documentation generation
- Django ORM integration

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        direction TB
        L1[Core Components]:::core
        L2([External Interfaces]):::interface
        L3[(Data Stores)]:::data
        L4{{Middleware}}:::middleware
    end

    subgraph Request_Flow
        direction TB
        HTTP([HTTP Request]):::interface
        DJANGO([Django URL Dispatcher]):::interface
        HTTP --> DJANGO
    end

    subgraph Core_Framework
        direction TB
        ROUTER["Router System"]:::core
        HANDLER["API Request Handler"]:::core
        OPERATION["Operation Handler"]:::core
        PARAMS["Parameter Parser"]:::core
        SCHEMA["Schema Management"]:::core
        RESPONSE["Response Handler"]:::core
        RENDER["Response Renderer"]:::core
        ERROR["Error Handler"]:::core
        
        ROUTER --> HANDLER
        HANDLER --> OPERATION
        OPERATION --> PARAMS
        PARAMS --> SCHEMA
        SCHEMA --> RESPONSE
        RESPONSE --> RENDER
        ERROR --> RESPONSE
    end

    subgraph Security_Layer
        direction TB
        AUTH{{Authentication}}:::middleware
        SEC{{Security Middleware}}:::middleware
        
        AUTH --> SEC
    end

    subgraph Integration_Layer
        direction TB
        ORM["ORM Integration"]:::core
        URL["URL Router"]:::core
        PAG["Pagination"]:::core
        
        ORM --> PAG
    end

    subgraph Documentation_Layer
        direction TB
        OPENAPI["OpenAPI Generator"]:::core
        SWAGGER["Swagger UI"]:::interface
        REDOC["Redoc UI"]:::interface
        
        OPENAPI --> SWAGGER
        OPENAPI --> REDOC
    end

    DJANGO --> ROUTER
    ROUTER --> AUTH
    SEC --> OPERATION
    SCHEMA --> ORM
    RESPONSE --> OPENAPI

    classDef core fill:#2374ab
    classDef interface fill:#57a773
    classDef data fill:#484d6d
    classDef middleware fill:#f7934c

    click HANDLER "https://github.com/vitalik/django-ninja/blob/master/ninja/main.py"
    click ROUTER "https://github.com/vitalik/django-ninja/blob/master/ninja/router.py"
    click SEC "https://github.com/vitalik/django-ninja/tree/master/ninja/security/"
    click SCHEMA "https://github.com/vitalik/django-ninja/blob/master/ninja/schema.py"
    click RESPONSE "https://github.com/vitalik/django-ninja/blob/master/ninja/responses.py"
    click PARAMS "https://github.com/vitalik/django-ninja/tree/master/ninja/params/"
    click ORM "https://github.com/vitalik/django-ninja/tree/master/ninja/orm/"
    click OPENAPI "https://github.com/vitalik/django-ninja/tree/master/ninja/openapi/"
    click RENDER "https://github.com/vitalik/django-ninja/blob/master/ninja/renderers.py"
    click AUTH "https://github.com/vitalik/django-ninja/blob/master/ninja/security/http.py"
    click SWAGGER "https://github.com/vitalik/django-ninja/blob/master/ninja/templates/ninja/swagger.html"
    click REDOC "https://github.com/vitalik/django-ninja/blob/master/ninja/templates/ninja/redoc.html"
    click URL "https://github.com/vitalik/django-ninja/blob/master/ninja/urls.py"
    click OPERATION "https://github.com/vitalik/django-ninja/blob/master/ninja/operation.py"
    click PAG "https://github.com/vitalik/django-ninja/blob/master/ninja/pagination.py"
    click ERROR "https://github.com/vitalik/django-ninja/blob/master/ninja/errors.py"
```
