diff --git a/README.md b/README.md index e8acfba..aa3c512 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,93 @@ -# FastAPI Application +# FastAPI REST API Service -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A REST API service built with FastAPI and SQLite for managing items. + +## Features + +- RESTful API with CRUD operations for items +- SQLite database with SQLAlchemy ORM +- Alembic for database migrations +- Pydantic for data validation +- API documentation with Swagger UI and ReDoc +- Health check endpoint +- CORS middleware + +## Project Structure + +``` +├── app +│ ├── api +│ │ ├── api.py +│ │ ├── deps.py +│ │ └── endpoints +│ │ ├── items.py +│ ├── core +│ ├── crud +│ │ ├── base.py +│ │ └── crud_item.py +│ ├── db +│ │ └── database.py +│ ├── models +│ │ ├── base.py +│ │ └── item.py +│ └── schemas +│ └── item.py +├── migrations +│ └── versions +│ └── 7e4c6a11c9d7_create_items_table.py +├── alembic.ini +├── main.py +└── requirements.txt +``` + +## Setup and Installation + +1. Clone the repository +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Run the application: + +```bash +uvicorn main:app --host 0.0.0.0 --port 8000 --reload +``` + +## API Endpoints + +### Health Check + +``` +GET /health +``` + +Returns the health status of the API. + +### Items API + +``` +GET /api/v1/items +POST /api/v1/items +GET /api/v1/items/{id} +PUT /api/v1/items/{id} +DELETE /api/v1/items/{id} +``` + +## API Documentation + +- Swagger UI: [http://localhost:8000/docs](http://localhost:8000/docs) +- ReDoc: [http://localhost:8000/redoc](http://localhost:8000/redoc) + +## Database + +The application uses SQLite as the database. The database file is stored at `/app/storage/db/db.sqlite`. + +## Database Migrations + +Migrations are managed with Alembic. The initial migration for creating the items table is already included. + +## License + +This project is licensed under the MIT License. \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..5a272eb --- /dev/null +++ b/alembic.ini @@ -0,0 +1,85 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the +# "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; this defaults +# to migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat migrations/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# SQLite URL +sqlalchemy.url = sqlite:////app/storage/db/db.sqlite + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks=black +# black.type=console_scripts +# black.entrypoint=black +# black.options=-l 79 + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..f9412be --- /dev/null +++ b/app/__init__.py @@ -0,0 +1,3 @@ +""" +App package. +""" \ No newline at end of file diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..1332bed --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1,3 @@ +""" +API package. +""" \ No newline at end of file diff --git a/app/api/api.py b/app/api/api.py new file mode 100644 index 0000000..5d708c1 --- /dev/null +++ b/app/api/api.py @@ -0,0 +1,9 @@ +""" +API router. +""" +from fastapi import APIRouter + +from app.api.endpoints import items + +api_router = APIRouter() +api_router.include_router(items.router, prefix="/items", tags=["items"]) \ No newline at end of file diff --git a/app/api/deps.py b/app/api/deps.py new file mode 100644 index 0000000..b006b27 --- /dev/null +++ b/app/api/deps.py @@ -0,0 +1,5 @@ +""" +API dependencies module. +""" + + diff --git a/app/api/endpoints/__init__.py b/app/api/endpoints/__init__.py new file mode 100644 index 0000000..bfd8b66 --- /dev/null +++ b/app/api/endpoints/__init__.py @@ -0,0 +1,3 @@ +""" +API endpoints package. +""" \ No newline at end of file diff --git a/app/api/endpoints/items.py b/app/api/endpoints/items.py new file mode 100644 index 0000000..50fc09e --- /dev/null +++ b/app/api/endpoints/items.py @@ -0,0 +1,105 @@ +""" +Items API endpoints. +""" +from typing import Any, List + +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app import crud, schemas +from app.db.database import get_db + +router = APIRouter() + + +@router.get("/", response_model=List[schemas.Item], summary="Get items") +def read_items( + db: Session = Depends(get_db), + skip: int = 0, + limit: int = 100, + active_only: bool = False, +) -> Any: + """ + Retrieve items. + """ + if active_only: + items = crud.item.get_active(db, skip=skip, limit=limit) + else: + items = crud.item.get_multi(db, skip=skip, limit=limit) + return items + + +@router.post("/", response_model=schemas.Item, status_code=status.HTTP_201_CREATED, summary="Create item") +def create_item( + *, + db: Session = Depends(get_db), + item_in: schemas.ItemCreate, +) -> Any: + """ + Create new item. + """ + item = crud.item.get_by_name(db, name=item_in.name) + if item: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail="Item with this name already exists", + ) + item = crud.item.create(db, obj_in=item_in) + return item + + +@router.get("/{id}", response_model=schemas.Item, summary="Get item by ID") +def read_item( + *, + db: Session = Depends(get_db), + id: int, +) -> Any: + """ + Get item by ID. + """ + item = crud.item.get(db, id=id) + if not item: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Item not found", + ) + return item + + +@router.put("/{id}", response_model=schemas.Item, summary="Update item") +def update_item( + *, + db: Session = Depends(get_db), + id: int, + item_in: schemas.ItemUpdate, +) -> Any: + """ + Update an item. + """ + item = crud.item.get(db, id=id) + if not item: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Item not found", + ) + item = crud.item.update(db, db_obj=item, obj_in=item_in) + return item + + +@router.delete("/{id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None, summary="Delete item") +def delete_item( + *, + db: Session = Depends(get_db), + id: int, +) -> None: + """ + Delete an item. + """ + item = crud.item.get(db, id=id) + if not item: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Item not found", + ) + crud.item.remove(db, id=id) + return None \ No newline at end of file diff --git a/app/core/__init__.py b/app/core/__init__.py new file mode 100644 index 0000000..cfcdc38 --- /dev/null +++ b/app/core/__init__.py @@ -0,0 +1,3 @@ +""" +Core package. +""" \ No newline at end of file diff --git a/app/crud/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..6ffa055 --- /dev/null +++ b/app/crud/__init__.py @@ -0,0 +1,4 @@ +""" +CRUD package. +""" +from app.crud.crud_item import item # noqa \ No newline at end of file diff --git a/app/crud/base.py b/app/crud/base.py new file mode 100644 index 0000000..b173dca --- /dev/null +++ b/app/crud/base.py @@ -0,0 +1,83 @@ +""" +Base CRUD module. +""" +from typing import Any, Dict, Generic, List, Optional, Type, TypeVar, Union + +from fastapi.encoders import jsonable_encoder +from pydantic import BaseModel +from sqlalchemy.orm import Session + +from app.db.database import Base + +ModelType = TypeVar("ModelType", bound=Base) +CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel) +UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel) + + +class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]): + """ + CRUD object with default methods to Create, Read, Update, Delete (CRUD). + """ + + def __init__(self, model: Type[ModelType]): + """ + CRUD object with default methods to Create, Read, Update, Delete (CRUD). + """ + self.model = model + + def get(self, db: Session, id: Any) -> Optional[ModelType]: + """ + Get a record by ID. + """ + return db.query(self.model).filter(self.model.id == id).first() + + def get_multi( + self, db: Session, *, skip: int = 0, limit: int = 100 + ) -> List[ModelType]: + """ + Get multiple records. + """ + return db.query(self.model).offset(skip).limit(limit).all() + + def create(self, db: Session, *, obj_in: CreateSchemaType) -> ModelType: + """ + Create a record. + """ + obj_in_data = jsonable_encoder(obj_in) + db_obj = self.model(**obj_in_data) # type: ignore + db.add(db_obj) + db.commit() + db.refresh(db_obj) + return db_obj + + def update( + self, + db: Session, + *, + db_obj: ModelType, + obj_in: Union[UpdateSchemaType, Dict[str, Any]] + ) -> ModelType: + """ + Update a record. + """ + obj_data = jsonable_encoder(db_obj) + if isinstance(obj_in, dict): + update_data = obj_in + else: + update_data = obj_in.model_dump(exclude_unset=True) + for field in obj_data: + if field in update_data: + setattr(db_obj, field, update_data[field]) + db.add(db_obj) + db.commit() + db.refresh(db_obj) + return db_obj + + def remove(self, db: Session, *, id: int) -> ModelType: + """ + Remove a record. + """ + obj = db.query(self.model).get(id) + db.delete(obj) + db.commit() + return obj \ No newline at end of file diff --git a/app/crud/crud_item.py b/app/crud/crud_item.py new file mode 100644 index 0000000..3b18cc9 --- /dev/null +++ b/app/crud/crud_item.py @@ -0,0 +1,30 @@ +""" +Item CRUD module. +""" +from typing import List, Optional + +from sqlalchemy.orm import Session + +from app.crud.base import CRUDBase +from app.models.item import Item +from app.schemas.item import ItemCreate, ItemUpdate + + +class CRUDItem(CRUDBase[Item, ItemCreate, ItemUpdate]): + """ + CRUD for Item. + """ + def get_by_name(self, db: Session, *, name: str) -> Optional[Item]: + """ + Get item by name. + """ + return db.query(Item).filter(Item.name == name).first() + + def get_active(self, db: Session, *, skip: int = 0, limit: int = 100) -> List[Item]: + """ + Get active items. + """ + return db.query(Item).filter(Item.is_active == True).offset(skip).limit(limit).all() # noqa + + +item = CRUDItem(Item) \ No newline at end of file diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..9e7c5b2 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1,3 @@ +""" +Database package. +""" \ No newline at end of file diff --git a/app/db/database.py b/app/db/database.py new file mode 100644 index 0000000..289c375 --- /dev/null +++ b/app/db/database.py @@ -0,0 +1,33 @@ +""" +Database connection module. +""" +from pathlib import Path +from sqlalchemy import create_engine +from sqlalchemy.ext.declarative import declarative_base +from sqlalchemy.orm import sessionmaker + +# Create database directory if it doesn't exist +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + +engine = create_engine( + SQLALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) + +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +Base = declarative_base() + + +def get_db(): + """ + Get database session. + """ + db = SessionLocal() + try: + yield db + finally: + db.close() \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..fe143e5 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,4 @@ +""" +Models package. +""" +from app.models.item import Item # noqa \ No newline at end of file diff --git a/app/models/base.py b/app/models/base.py new file mode 100644 index 0000000..28694f9 --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,17 @@ +""" +Base model module. +""" +from datetime import datetime +from sqlalchemy import Column, DateTime, Integer +from app.db.database import Base + + +class BaseModel(Base): + """ + Base model for all models. + """ + __abstract__ = True + + id = Column(Integer, primary_key=True, index=True) + created_at = Column(DateTime, default=datetime.utcnow) + updated_at = Column(DateTime, default=datetime.utcnow, onupdate=datetime.utcnow) \ No newline at end of file diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 0000000..a1b5327 --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,16 @@ +""" +Item model module. +""" +from sqlalchemy import Column, String, Text, Boolean +from app.models.base import BaseModel + + +class Item(BaseModel): + """ + Item model. + """ + __tablename__ = "items" + + name = Column(String(255), index=True, nullable=False) + description = Column(Text, nullable=True) + is_active = Column(Boolean, default=True) \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..be180d2 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,4 @@ +""" +Schemas package. +""" +from app.schemas.item import Item, ItemCreate, ItemUpdate # noqa \ No newline at end of file diff --git a/app/schemas/item.py b/app/schemas/item.py new file mode 100644 index 0000000..46f0710 --- /dev/null +++ b/app/schemas/item.py @@ -0,0 +1,54 @@ +""" +Item schema module. +""" +from datetime import datetime +from typing import Optional +from pydantic import BaseModel, Field + + +class ItemBase(BaseModel): + """ + Base schema for Item. + """ + name: str = Field(..., min_length=1, max_length=255, description="The name of the item") + description: Optional[str] = Field(None, description="The description of the item") + is_active: bool = Field(True, description="Whether the item is active") + + +class ItemCreate(ItemBase): + """ + Schema for creating an Item. + """ + pass + + +class ItemUpdate(BaseModel): + """ + Schema for updating an Item. + """ + name: Optional[str] = Field(None, min_length=1, max_length=255, description="The name of the item") + description: Optional[str] = Field(None, description="The description of the item") + is_active: Optional[bool] = Field(None, description="Whether the item is active") + + +class ItemInDBBase(ItemBase): + """ + Base schema for Item in DB. + """ + id: int + created_at: datetime + updated_at: datetime + + class Config: + """ + Pydantic config. + """ + orm_mode = True + from_attributes = True + + +class Item(ItemInDBBase): + """ + Schema for Item. + """ + pass \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..7322e82 --- /dev/null +++ b/main.py @@ -0,0 +1,44 @@ +""" +FastAPI REST API main module. +""" +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +import uvicorn + +from app.api.api import api_router +from app.db.database import Base, engine + +# Create tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="REST API Service", + description="A REST API service built with FastAPI and SQLite", + version="0.1.0", + docs_url="/docs", + redoc_url="/redoc", +) + +# Add CORS middleware +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], # Update this in production to specific origins + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include API router +app.include_router(api_router, prefix="/api/v1") + + +@app.get("/health", tags=["Health"]) +async def health_check(): + """ + Health check endpoint. + """ + return {"status": "healthy"} + + +if __name__ == "__main__": + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..3542e0e --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration with SQLite. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..afcd539 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,83 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# Import models for Alembic to detect +from app.db.database import Base +from app.models import Item # noqa + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +target_metadata = Base.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + is_sqlite = connection.dialect.name == "sqlite" + context.configure( + connection=connection, + target_metadata=target_metadata, + render_as_batch=is_sqlite, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() \ No newline at end of file diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..37d0cac --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} \ No newline at end of file diff --git a/migrations/versions/7e4c6a11c9d7_create_items_table.py b/migrations/versions/7e4c6a11c9d7_create_items_table.py new file mode 100644 index 0000000..5bf1d1b --- /dev/null +++ b/migrations/versions/7e4c6a11c9d7_create_items_table.py @@ -0,0 +1,37 @@ +"""create items table + +Revision ID: 7e4c6a11c9d7 +Revises: +Create Date: 2023-10-10 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '7e4c6a11c9d7' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table( + 'items', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('created_at', sa.DateTime(), nullable=True), + sa.Column('updated_at', sa.DateTime(), nullable=True), + sa.Column('name', sa.String(length=255), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('is_active', sa.Boolean(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_items_id'), 'items', ['id'], unique=False) + op.create_index(op.f('ix_items_name'), 'items', ['name'], unique=False) + + +def downgrade() -> None: + op.drop_index(op.f('ix_items_name'), table_name='items') + op.drop_index(op.f('ix_items_id'), table_name='items') + op.drop_table('items') \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c758f1e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,10 @@ +fastapi>=0.95.0 +uvicorn>=0.22.0 +sqlalchemy>=2.0.0 +alembic>=1.10.0 +pydantic>=2.0.0 +python-dotenv>=1.0.0 +ruff>=0.0.292 +email-validator>=2.0.0 +aiosqlite>=0.19.0 +python-multipart>=0.0.6 \ No newline at end of file