From 109d0c91b811decdec3e0b970f4d18a2ac0d8f85 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Fri, 6 Jun 2025 09:44:58 +0000 Subject: [PATCH] Create FastAPI application with basic CRUD functionality - Set up project structure with FastAPI app - Implement items CRUD API endpoints - Configure SQLite database with SQLAlchemy - Set up Alembic migrations - Add health check endpoint - Enable CORS middleware - Create README with documentation --- README.md | 128 +++++++++++++++++- alembic.ini | 102 ++++++++++++++ app/__init__.py | 1 + app/api/__init__.py | 1 + app/api/v1/__init__.py | 1 + app/api/v1/api.py | 5 + app/api/v1/endpoints/__init__.py | 1 + app/api/v1/endpoints/items.py | 39 ++++++ app/core/config.py | 13 ++ app/crud/__init__.py | 1 + app/crud/item.py | 39 ++++++ app/db/__init__.py | 1 + app/db/base.py | 4 + app/db/session.py | 27 ++++ app/models/__init__.py | 1 + app/models/item.py | 12 ++ app/schemas/__init__.py | 1 + app/schemas/item.py | 21 +++ main.py | 48 +++++++ migrations/README | 1 + migrations/env.py | 82 +++++++++++ migrations/script.py.mako | 24 ++++ .../53b8c3f67ecb_create_items_table.py | 33 +++++ requirements.txt | 8 ++ 24 files changed, 592 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 app/__init__.py create mode 100644 app/api/__init__.py create mode 100644 app/api/v1/__init__.py create mode 100644 app/api/v1/api.py create mode 100644 app/api/v1/endpoints/__init__.py create mode 100644 app/api/v1/endpoints/items.py create mode 100644 app/core/config.py create mode 100644 app/crud/__init__.py create mode 100644 app/crud/item.py create mode 100644 app/db/__init__.py create mode 100644 app/db/base.py create mode 100644 app/db/session.py create mode 100644 app/models/__init__.py create mode 100644 app/models/item.py create mode 100644 app/schemas/__init__.py create mode 100644 app/schemas/item.py create mode 100644 main.py create mode 100644 migrations/README create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/53b8c3f67ecb_create_items_table.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..14203df 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,127 @@ -# FastAPI Application +# Quick API Service -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A simple FastAPI application that provides a quick working API with basic CRUD operations. + +## Features + +- RESTful API with FastAPI +- SQLite database with SQLAlchemy ORM +- Alembic migrations for database versioning +- CORS middleware enabled +- Health check endpoint +- Swagger documentation at `/docs` +- ReDoc documentation at `/redoc` + +## Project Structure + +``` +. +├── app +│ ├── api +│ │ └── v1 +│ │ ├── api.py +│ │ └── endpoints +│ │ └── items.py +│ ├── core +│ │ └── config.py +│ ├── crud +│ │ └── item.py +│ ├── db +│ │ ├── base.py +│ │ └── session.py +│ ├── models +│ │ └── item.py +│ ├── schemas +│ │ └── item.py +│ └── storage +│ └── db +├── migrations +│ ├── env.py +│ ├── README +│ ├── script.py.mako +│ └── versions +│ └── 53b8c3f67ecb_create_items_table.py +├── alembic.ini +├── main.py +├── README.md +└── requirements.txt +``` + +## Installation + +1. Clone the repository: + +```bash +git clone +cd quickapiservice +``` + +2. Install dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Run the migrations: + +```bash +alembic upgrade head +``` + +4. Start the application: + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000 + +## API Endpoints + +- `GET /`: Root endpoint with basic information +- `GET /health`: Health check endpoint +- `GET /docs`: Swagger documentation +- `GET /redoc`: ReDoc documentation + +### Items API + +- `GET /api/v1/items`: Get all items +- `POST /api/v1/items`: Create a new item +- `GET /api/v1/items/{item_id}`: Get an item by ID +- `PUT /api/v1/items/{item_id}`: Update an item +- `DELETE /api/v1/items/{item_id}`: Delete an item + +## Example API Usage + +### Create an Item + +```bash +curl -X 'POST' \ + 'http://localhost:8000/api/v1/items/' \ + -H 'Content-Type: application/json' \ + -d '{ + "title": "Example Item", + "description": "This is an example item" +}' +``` + +### Get All Items + +```bash +curl -X 'GET' 'http://localhost:8000/api/v1/items/' +``` + +## Development + +The application uses SQLite for the database, which is stored at `/app/storage/db/db.sqlite`. + +To apply new migrations: + +```bash +alembic revision --autogenerate -m "description" +alembic upgrade head +``` + +## 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..98965b6 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,102 @@ +# 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 + +# 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. + +# 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..2bcdea1 --- /dev/null +++ b/app/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python 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..2bcdea1 --- /dev/null +++ b/app/api/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/v1/__init__.py b/app/api/v1/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/api/v1/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/v1/api.py b/app/api/v1/api.py new file mode 100644 index 0000000..09fdcce --- /dev/null +++ b/app/api/v1/api.py @@ -0,0 +1,5 @@ +from fastapi import APIRouter +from app.api.v1.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/v1/endpoints/__init__.py b/app/api/v1/endpoints/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/api/v1/endpoints/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/api/v1/endpoints/items.py b/app/api/v1/endpoints/items.py new file mode 100644 index 0000000..9b21603 --- /dev/null +++ b/app/api/v1/endpoints/items.py @@ -0,0 +1,39 @@ +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session +from typing import List + +from app.db.session import get_db +from app.schemas.item import Item, ItemCreate, ItemUpdate +from app.crud import item as item_crud + +router = APIRouter() + +@router.get("/", response_model=List[Item]) +def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + items = item_crud.get_items(db, skip=skip, limit=limit) + return items + +@router.post("/", response_model=Item, status_code=status.HTTP_201_CREATED) +def create_item(item: ItemCreate, db: Session = Depends(get_db)): + return item_crud.create_item(db=db, item=item) + +@router.get("/{item_id}", response_model=Item) +def read_item(item_id: int, db: Session = Depends(get_db)): + db_item = item_crud.get_item(db, item_id=item_id) + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + return db_item + +@router.put("/{item_id}", response_model=Item) +def update_item(item_id: int, item: ItemUpdate, db: Session = Depends(get_db)): + db_item = item_crud.update_item(db, item_id=item_id, item=item) + if db_item is None: + raise HTTPException(status_code=404, detail="Item not found") + 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)): + success = item_crud.delete_item(db, item_id=item_id) + if not success: + raise HTTPException(status_code=404, detail="Item not found") + return None \ No newline at end of file diff --git a/app/core/config.py b/app/core/config.py new file mode 100644 index 0000000..ef04407 --- /dev/null +++ b/app/core/config.py @@ -0,0 +1,13 @@ +from pydantic_settings import BaseSettings + +class Settings(BaseSettings): + API_V1_STR: str = "/api/v1" + PROJECT_NAME: str = "Quick API Service" + + # Set environment variables if needed + # DATABASE_URL: str = os.environ.get("DATABASE_URL", "sqlite:///./app.db") + + class Config: + env_file = ".env" + +settings = Settings() \ No newline at end of file diff --git a/app/crud/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/crud/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/crud/item.py b/app/crud/item.py new file mode 100644 index 0000000..d79181d --- /dev/null +++ b/app/crud/item.py @@ -0,0 +1,39 @@ +from sqlalchemy.orm import Session +from app.models.item import Item +from app.schemas.item import ItemCreate, ItemUpdate +from typing import List, Optional + +def get_items(db: Session, skip: int = 0, limit: int = 100) -> List[Item]: + return db.query(Item).offset(skip).limit(limit).all() + +def get_item(db: Session, item_id: int) -> Optional[Item]: + return db.query(Item).filter(Item.id == item_id).first() + +def create_item(db: Session, item: ItemCreate) -> Item: + db_item = Item(**item.model_dump()) + db.add(db_item) + db.commit() + db.refresh(db_item) + return db_item + +def update_item(db: Session, item_id: int, item: ItemUpdate) -> Optional[Item]: + db_item = get_item(db, item_id) + if db_item is None: + return None + + update_data = item.model_dump(exclude_unset=True) + for key, value in update_data.items(): + setattr(db_item, key, value) + + db.commit() + db.refresh(db_item) + return db_item + +def delete_item(db: Session, item_id: int) -> bool: + db_item = get_item(db, item_id) + if db_item is None: + return False + + db.delete(db_item) + db.commit() + return True \ No newline at end of file diff --git a/app/db/__init__.py b/app/db/__init__.py new file mode 100644 index 0000000..2bcdea1 --- /dev/null +++ b/app/db/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/db/base.py b/app/db/base.py new file mode 100644 index 0000000..4e54450 --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,4 @@ +from sqlalchemy.ext.declarative import declarative_base + +# Create a base class for SQLAlchemy models +Base = declarative_base() \ No newline at end of file diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..2f14efe --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,27 @@ +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from pathlib import Path + +# Create database directory if it doesn't exist +DB_DIR = Path("/app") / "storage" / "db" +DB_DIR.mkdir(parents=True, exist_ok=True) + +# Database URL +SQLALCHEMY_DATABASE_URL = f"sqlite:///{DB_DIR}/db.sqlite" + +# Create SQLAlchemy engine +engine = create_engine( + SQLALCHEMY_DATABASE_URL, + connect_args={"check_same_thread": False} +) + +# Create SessionLocal class +SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) + +# Dependency for getting DB session +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..49b0dd6 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1 @@ +from app.models.item import Item # noqa \ No newline at end of file diff --git a/app/models/item.py b/app/models/item.py new file mode 100644 index 0000000..e3bdd2a --- /dev/null +++ b/app/models/item.py @@ -0,0 +1,12 @@ +from sqlalchemy import Column, Integer, String, Text, DateTime +from sqlalchemy.sql import func +from app.db.base import Base + +class Item(Base): + __tablename__ = "items" + + id = Column(Integer, primary_key=True, index=True) + title = Column(String(100), nullable=False) + description = Column(Text, nullable=True) + created_at = Column(DateTime(timezone=True), server_default=func.now()) + updated_at = Column(DateTime(timezone=True), 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..2bcdea1 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1 @@ +# This file is intentionally left empty to make the directory a Python package \ No newline at end of file diff --git a/app/schemas/item.py b/app/schemas/item.py new file mode 100644 index 0000000..ddbd38d --- /dev/null +++ b/app/schemas/item.py @@ -0,0 +1,21 @@ +from pydantic import BaseModel +from datetime import datetime +from typing import Optional + +class ItemBase(BaseModel): + title: str + description: Optional[str] = None + +class ItemCreate(ItemBase): + pass + +class ItemUpdate(ItemBase): + title: Optional[str] = None + +class Item(ItemBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + 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..92577b7 --- /dev/null +++ b/main.py @@ -0,0 +1,48 @@ +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware +import uvicorn + +from app.api.v1.api import api_router +from app.core.config import settings +from app.db.base import Base +from app.db.session import engine + +# Create FastAPI app +app = FastAPI( + title="Quick API Service", + description="A simple FastAPI service with basic functionality", + version="0.1.0", + openapi_url="/openapi.json", +) + +# Configure CORS +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Create database tables +Base.metadata.create_all(bind=engine) + +# Include API router +app.include_router(api_router, prefix=settings.API_V1_STR) + +# Health check endpoint +@app.get("/health", tags=["Health"]) +async def health_check(): + return {"status": "healthy"} + +# Root endpoint +@app.get("/", tags=["Root"]) +async def root(): + return { + "title": settings.PROJECT_NAME, + "docs": "/docs", + "health": "/health" + } + +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..7af7ec3 --- /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 + +# Import models for Alembic autogenerate support +from app.db.base import Base + +# 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, # Key configuration for 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/53b8c3f67ecb_create_items_table.py b/migrations/versions/53b8c3f67ecb_create_items_table.py new file mode 100644 index 0000000..0cf174b --- /dev/null +++ b/migrations/versions/53b8c3f67ecb_create_items_table.py @@ -0,0 +1,33 @@ +"""create items table + +Revision ID: 53b8c3f67ecb +Revises: +Create Date: 2023-12-01 00:00:00.000000 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '53b8c3f67ecb' +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('title', sa.String(length=100), nullable=False), + sa.Column('description', sa.Text(), nullable=True), + sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=True), + sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_items_id'), 'items', ['id'], unique=False) + + +def downgrade() -> None: + 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..1707caf --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +fastapi>=0.104.1 +uvicorn>=0.24.0 +pydantic>=2.4.2 +pydantic-settings>=2.0.3 +sqlalchemy>=2.0.23 +alembic>=1.12.1 +python-multipart>=0.0.6 +ruff>=0.1.6 \ No newline at end of file