# ivanshepeta/fastapi_crud_test architecture

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

- Interactive diagram: https://gitdiagram.com/ivanshepeta/fastapi_crud_test
- Repository: https://github.com/ivanshepeta/fastapi_crud_test

## Overview

##### Project type and purpose
- This is a lightweight full-stack API project (“FastAPI CRUD Test”) demonstrating basic Create, Read, Update, Delete operations on a “books” resource.
- It uses FastAPI as the HTTP framework, SQLAlchemy+aiosqlite for async database access, and Pydantic for data models/validation.

##### File structure
- main.py
– Instantiates FastAPI app, includes routers/endpoints, and configures DB setup endpoint.
- read.py
– Contains SQLAlchemy model definitions, session setup (async engine bound to aiosqlite), and CRUD functions.
- mydb.db
– The SQLite database file.
- tests/
– test.py uses pytest and FastAPI’s TestClient to verify each endpoint.
- img/
– Screenshots of the auto-generated FastAPI docs.

##### README for additional insights
- Endpoints: POST /books, GET /books, PUT /books/{id}, DELETE /books/{id}, POST /setup
- Technologies & libraries: FastAPI, SQLAlchemy, aiosqlite, Pydantic, pytest

a. Client(s) (e.g., browser, Postman)
b. FastAPI HTTP server layer
– Path operations for /books and /setup
c. Controller/Router layer (inside main.py)
– Routes map HTTP requests → CRUD functions
d. Service/Data-access layer (in read.py)
– SQLAlchemy model (Book)
– AsyncSession factory using aiosqlite engine
– CRUD functions: create_book, get_books, update_book, delete_book, reset_db
e. Persistence layer
– SQLite database file (mydb.db)
f. Testing layer
– pytest + FastAPI TestClient

##### Relationships & interactions
- Router → Data-access functions (async calls)
- Data-access → SQLite (SQL queries over aiosqlite)
- SQLite → Data-access (results returned as ORM objects)
- Data-access → Router → Client (HTTP response)
- Tests simulate Client → Router → verify Repository and DB state

##### Architectural patterns & design principles
- Layered architecture: Presentation (FastAPI), Business/Data-access (CRUD in read.py), Persistence (SQLite)
- Async I/O: all DB operations are non-blocking (aiosqlite + SQLAlchemy AsyncEngine)
- Separation of concerns: routing logic in main.py, ORM and CRUD in read.py, tests isolated in tests/

- All components labeled clearly

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client
    Client["Client (Browser/Postman)"]
    click Client "https://github.com/ivanshepeta/fastapi_crud_test/tree/master/N/A"

    %% API Layer
    subgraph "API Layer"
        Router["FastAPI Router\n(main.py)"]:::api
        Schemas["Pydantic Schemas"]:::api
    end

    %% Service/Data-access Layer
    subgraph "Service/Data-access Layer"
        Service["CRUD Module\n(read.py)\n- AsyncEngine\n- AsyncSession\n- Book Model\n- CRUD functions"]:::service
    end

    %% Persistence Layer
    DB((SQLite DB\nmydb.db)):::db

    %% Testing Layer
    subgraph "Testing Layer"
        TestClient["TestClient\n(pytest)"]:::test
        TestInit["tests/__init__.py"]:::test
        TestFile["tests/test.py"]:::test
    end

    %% Data Flows
    Client -->|"POST/GET/PUT/DELETE /books\nPOST /setup"| Router
    Router -->|"uses Pydantic models"| Schemas
    Router -->|"async calls"| Service
    Service -->|"aiosqlite query"| DB
    DB -->|"ORM objects"| Service
    Service -->|"data returned"| Router
    Router -->|"JSON response"| Client

    %% Testing interactions
    TestClient -.->|"simulated HTTP requests"| Router
    TestClient -.->|"verifies DB state"| DB
    TestClient --> TestInit
    TestClient --> TestFile

    %% Click Events
    click Router "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/main.py"
    click Service "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/read.py"
    click DB "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/mydb.db"
    click TestInit "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/tests/__init__.py"
    click TestFile "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/tests/test.py"
    click TestClient "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/tests/test.py"
    click Schemas "https://github.com/ivanshepeta/fastapi_crud_test/blob/master/main.py"
    click Client "https://github.com/ivanshepeta/fastapi_crud_test/tree/master/N/A"

    %% Styles
    classDef api fill:#cce5ff,stroke:#333,stroke-width:1px;
    classDef service fill:#d4edda,stroke:#333,stroke-width:1px;
    classDef db fill:#fff3cd,stroke:#333,stroke-width:1px;
    classDef test fill:#e2e3e5,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5;
    class Router,Schemas api
    class Service service
    class DB db
    class TestClient,TestInit,TestFile test
```
