How ivanshepeta/fastapi_crud_test works
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