diff --git a/README.md b/README.md index e8acfba..795d604 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,91 @@ -# FastAPI Application +# FastAPI REST API -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +This is a FastAPI-based REST API application that provides CRUD operations for managing items. + +## Features + +- FastAPI framework for high-performance API development +- SQLAlchemy ORM with SQLite database +- Alembic for database migrations +- Pydantic for data validation +- CRUD operations for items +- Health check endpoint +- Interactive API documentation + +## Project Structure + +``` +├── app/ # Application package +│ ├── api/ # API endpoints +│ │ ├── endpoints/ # API route handlers +│ │ │ └── items.py # Items API endpoints +│ ├── core/ # Core application modules +│ │ ├── app.py # FastAPI application factory +│ │ └── config.py # Application configuration +│ ├── db/ # Database related modules +│ │ ├── base.py # Import all models for Alembic +│ │ ├── base_class.py # Base class for SQLAlchemy models +│ │ └── session.py # Database session setup +│ ├── models/ # SQLAlchemy models +│ │ └── item.py # Item model +│ └── schemas/ # Pydantic schemas +│ └── item.py # Item schemas +├── migrations/ # Alembic migrations +│ ├── versions/ # Migration scripts +│ ├── env.py # Alembic environment configuration +│ └── script.py.mako # Alembic script template +├── alembic.ini # Alembic configuration +├── main.py # Application entry point +└── requirements.txt # Project dependencies +``` + +## Setup and Installation + +1. Clone the repository: + ```bash + git clone + cd genericrestapi-3gclpr + ``` + +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 + ``` + +4. Access the API documentation: + - Swagger UI: [http://localhost:8000/docs](http://localhost:8000/docs) + - ReDoc: [http://localhost:8000/redoc](http://localhost:8000/redoc) + +## API Endpoints + +### Health Check +- `GET /health`: Check the health status of the API + +### Items API +- `POST /api/v1/items`: Create a new item +- `GET /api/v1/items`: List all items (with pagination) +- `GET /api/v1/items/{item_id}`: Get a specific item by ID +- `PUT /api/v1/items/{item_id}`: Update an item +- `DELETE /api/v1/items/{item_id}`: Delete an item + +## Database Migrations + +Create a new migration: +```bash +alembic revision --autogenerate -m "description" +``` + +Apply migrations: +```bash +alembic upgrade head +``` + +Revert migrations: +```bash +alembic downgrade -1 +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..80b926f --- /dev/null +++ b/alembic.ini @@ -0,0 +1,110 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# 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. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +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 REVISION_SCRIPT_FILENAME + +# 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..e69de29 diff --git a/app/api/__init__.py b/app/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/api.py b/app/api/api.py new file mode 100644 index 0000000..c24cf3d --- /dev/null +++ b/app/api/api.py @@ -0,0 +1,5 @@ +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/endpoints/__init__.py b/app/api/endpoints/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/endpoints/items.py b/app/api/endpoints/items.py new file mode 100644 index 0000000..44e0fa1 --- /dev/null +++ b/app/api/endpoints/items.py @@ -0,0 +1,59 @@ +from typing import List +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.db.session import get_db +from app.models.item import Item +from app.schemas.item import ItemCreate, ItemResponse, ItemUpdate + +router = APIRouter() + + +@router.post("", response_model=ItemResponse, status_code=status.HTTP_201_CREATED) +def create_item(item: ItemCreate, db: Session = Depends(get_db)): + db_item = Item(**item.model_dump()) + db.add(db_item) + db.commit() + db.refresh(db_item) + return db_item + + +@router.get("", response_model=List[ItemResponse]) +def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + items = db.query(Item).offset(skip).limit(limit).all() + return items + + +@router.get("/{item_id}", response_model=ItemResponse) +def read_item(item_id: int, db: Session = Depends(get_db)): + item = db.query(Item).filter(Item.id == item_id).first() + if item is None: + raise HTTPException(status_code=404, detail="Item not found") + return item + + +@router.put("/{item_id}", response_model=ItemResponse) +def update_item(item_id: int, item: ItemUpdate, db: Session = Depends(get_db)): + db_item = db.query(Item).filter(Item.id == item_id).first() + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + + update_data = item.model_dump(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_item, key, value) + + db.add(db_item) + db.commit() + db.refresh(db_item) + return db_item + + +@router.delete("/{item_id}", status_code=status.HTTP_204_NO_CONTENT, response_model=None) +def delete_item(item_id: int, db: Session = Depends(get_db)): + db_item = db.query(Item).filter(Item.id == item_id).first() + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + + db.delete(db_item) + db.commit() + 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..e69de29 diff --git a/app/core/app.py b/app/core/app.py new file mode 100644 index 0000000..8f3854c --- /dev/null +++ b/app/core/app.py @@ -0,0 +1,21 @@ +from fastapi import FastAPI +from app.api.api import api_router +from app.core.config import settings + +def create_app() -> FastAPI: + app = FastAPI( + title=settings.PROJECT_NAME, + description=settings.PROJECT_DESCRIPTION, + version=settings.VERSION, + openapi_url=f"{settings.API_V1_STR}/openapi.json", + docs_url="/docs", + redoc_url="/redoc", + ) + + app.include_router(api_router, prefix=settings.API_V1_STR) + + @app.get("/health", tags=["Health"]) + def health_check(): + return {"status": "ok"} + + return app \ No newline at end of file diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..64aeb3f --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,19 @@ +from pydantic_settings import BaseSettings +from pathlib import Path + + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + PROJECT_NAME: str = "GenericRestAPI" + PROJECT_DESCRIPTION: str = "A FastAPI-based REST API" + VERSION: str = "0.1.0" + + # Database settings + DB_DIR: Path = Path("/app") / "storage" / "db" + SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite" + + class Config: + case_sensitive = True + + +settings = Settings() \ No newline at end of file diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/db/base.py b/app/db/base.py new file mode 100644 index 0000000..cb86f7f --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,3 @@ +# Import all the models, so that Base has them before being imported by Alembic +from app.db.base_class import Base # noqa +from app.models.item import Item # noqa \ No newline at end of file diff --git a/app/db/base_class.py b/app/db/base_class.py new file mode 100644 index 0000000..a474ab1 --- /dev/null +++ b/app/db/base_class.py @@ -0,0 +1,13 @@ +from typing import Any +from sqlalchemy.ext.declarative import declared_attr +from sqlalchemy.orm import DeclarativeBase + + +class Base(DeclarativeBase): + id: Any + __name__: str + + # Generate __tablename__ automatically + @declared_attr + def __tablename__(cls) -> str: + return cls.__name__.lower() \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..14fc91c --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,24 @@ +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +from app.core.config import settings + +# Ensure the database directory exists +DB_DIR = settings.DB_DIR +DB_DIR.mkdir(parents=True, exist_ok=True) + +SQLALCHEMY_DATABASE_URL = settings.SQLALCHEMY_DATABASE_URL + +engine = create_engine( + SQLALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + + +def get_db(): + 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..e69de29 diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 0000000..249dc1d --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,15 @@ +from sqlalchemy import Column, String, Integer, Boolean, Text +from sqlalchemy.sql import func +from sqlalchemy.sql.sqltypes import DateTime + +from app.db.base_class import Base + + +class Item(Base): + id = Column(Integer, primary_key=True, index=True) + name = Column(String(100), index=True, nullable=False) + description = Column(Text, nullable=True) + price = Column(Integer, nullable=False) # Store price in cents + is_active = Column(Boolean, default=True) + created_at = Column(DateTime, server_default=func.now()) + updated_at = Column(DateTime, server_default=func.now(), onupdate=func.now()) \ No newline at end of file diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/schemas/item.py b/app/schemas/item.py new file mode 100644 index 0000000..9e292b7 --- /dev/null +++ b/app/schemas/item.py @@ -0,0 +1,30 @@ +from datetime import datetime +from typing import Optional +from pydantic import BaseModel, Field + + +class ItemBase(BaseModel): + name: str = Field(..., min_length=1, max_length=100) + description: Optional[str] = None + price: int = Field(..., gt=0) # Price in cents + is_active: bool = True + + +class ItemCreate(ItemBase): + pass + + +class ItemUpdate(BaseModel): + name: Optional[str] = Field(None, min_length=1, max_length=100) + description: Optional[str] = None + price: Optional[int] = Field(None, gt=0) + is_active: Optional[bool] = None + + +class ItemResponse(ItemBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000..9430f0c --- /dev/null +++ b/main.py @@ -0,0 +1,7 @@ +import uvicorn +from app.core.app import create_app + +app = create_app() + +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..f3a049c --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration with SQLAlchemy. \ No newline at end of file diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 0000000..92c3e0f --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,82 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +# 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 +# Import the Base to support autogenerate +from app.db.base import Base # noqa: E402 +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, + compare_type=True, + ) + + 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/f2f2f2f2f2f2_create_items_table.py b/migrations/versions/f2f2f2f2f2f2_create_items_table.py new file mode 100644 index 0000000..ca2aa8d --- /dev/null +++ b/migrations/versions/f2f2f2f2f2f2_create_items_table.py @@ -0,0 +1,41 @@ +"""create items table + +Revision ID: f2f2f2f2f2f2 +Revises: +Create Date: 2023-10-29 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f2f2f2f2f2f2' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('item', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=100), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('price', sa.Integer(), nullable=False), + sa.Column('is_active', sa.Boolean(), nullable=True), + sa.Column('created_at', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True), + sa.Column('updated_at', sa.DateTime(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_item_id'), 'item', ['id'], unique=False) + op.create_index(op.f('ix_item_name'), 'item', ['name'], unique=False) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_item_name'), table_name='item') + op.drop_index(op.f('ix_item_id'), table_name='item') + op.drop_table('item') + # ### end Alembic commands ### \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3fc28f1 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +fastapi>=0.104.0 +uvicorn>=0.23.2 +sqlalchemy>=2.0.0 +alembic>=1.12.0 +pydantic>=2.4.2 +pydantic-settings>=2.0.3 +python-multipart>=0.0.6 +ruff>=0.1.0 \ No newline at end of file