Create FastAPI Todo API with SQLite

Generated with BackendIM... (backend.im)

README.md

@@ -1,3 +1,59 @@
-# FastAPI Application
+# FastAPI Todo API
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+This is a simple Todo API built with FastAPI and SQLite.
+
+## Features
+
+- Create, read, update, and delete todos
+- SQLite database with SQLAlchemy ORM
+- Alembic for database migrations
+- Health check endpoint
+
+## Project Structure
+
+```
+.
+├── alembic/            # Database migration files
+├── app/                # Application code
+│   ├── api/            # API endpoints
+│   ├── core/           # Core functionality and config
+│   ├── crud/           # CRUD operations
+│   ├── db/             # Database setup
+│   ├── models/         # SQLAlchemy models
+│   └── schemas/        # Pydantic schemas
+├── alembic.ini         # Alembic configuration
+├── main.py             # Application entry point
+└── requirements.txt    # Project dependencies
+```
+
+## Getting Started
+
+1. Clone the repository
+2. Install the dependencies:
+   ```
+   pip install -r requirements.txt
+   ```
+3. Run the migrations:
+   ```
+   alembic upgrade head
+   ```
+4. Start the server:
+   ```
+   uvicorn main:app --reload
+   ```
+
+## API Documentation
+
+Once the server is running, you can access the API documentation at:
+
+- Swagger UI: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+## API Endpoints
+
+- `GET /api/v1/todos/`: Get all todos
+- `POST /api/v1/todos/`: Create a new todo
+- `GET /api/v1/todos/{todo_id}`: Get a specific todo by ID
+- `PUT /api/v1/todos/{todo_id}`: Update a specific todo
+- `DELETE /api/v1/todos/{todo_id}`: Delete a specific todo
+- `GET /health`: Health check endpoint

alembic.ini

@@ -0,0 +1,84 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# 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 alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat alembic/versions
+
+# 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
+
+# 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.stdout,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/env.py

@@ -0,0 +1,78 @@
+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.
+fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from app.db.base import Base
+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():
+    """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():
+    """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:
+        context.configure(
+            connection=connection, target_metadata=target_metadata
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/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():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

alembic/versions/001_create_todos_table.py

@@ -0,0 +1,37 @@
+"""create todos table
+
+Revision ID: 001
+Revises: 
+Create Date: 2025-05-13
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '001'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'todos',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('title', sa.String(), nullable=True),
+        sa.Column('description', sa.String(), nullable=True),
+        sa.Column('completed', sa.Boolean(), default=False),
+        sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
+        sa.Column('updated_at', sa.DateTime(timezone=True), nullable=True),
+        sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_todos_id'), 'todos', ['id'], unique=False)
+    op.create_index(op.f('ix_todos_title'), 'todos', ['title'], unique=False)
+
+
+def downgrade():
+    op.drop_index(op.f('ix_todos_title'), table_name='todos')
+    op.drop_index(op.f('ix_todos_id'), table_name='todos')
+    op.drop_table('todos')

app/__init__.py

@@ -0,0 +1 @@
+# This file makes the app directory a Python package

app/api/__init__.py

@@ -0,0 +1 @@
+# This file makes the api directory a Python package

app/api/endpoints/__init__.py

@@ -0,0 +1 @@
+# This file makes the endpoints directory a Python package

app/api/endpoints/health.py

@@ -0,0 +1,29 @@
+from fastapi import APIRouter, Depends
+from sqlalchemy.orm import Session
+from sqlalchemy import text
+
+from app.db.session import get_db
+
+router = APIRouter()
+
+
+@router.get("/health")
+def health_check(db: Session = Depends(get_db)):
+    """
+    Health check endpoint.
+    
+    Returns:
+        dict: Status of the service and its dependencies.
+    """
+    # Check database connectivity
+    try:
+        db.execute(text("SELECT 1"))
+        db_status = "healthy"
+    except Exception as e:
+        db_status = f"unhealthy: {str(e)}"
+    
+    return {
+        "status": "healthy",
+        "database": db_status,
+        "version": "0.1.0"
+    }

app/api/endpoints/todo.py

@@ -0,0 +1,77 @@
+from typing import List, Optional
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.orm import Session
+
+from app.db.session import get_db
+from app.schemas.todo import Todo, TodoCreate, TodoUpdate
+from app.crud import todo as todo_crud
+
+router = APIRouter()
+
+
+@router.get("/todos/", response_model=List[Todo])
+def read_todos(
+    skip: int = 0,
+    limit: int = 100,
+    db: Session = Depends(get_db)
+):
+    """
+    Retrieve todos.
+    """
+    todos = todo_crud.get_todos(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.post("/todos/", response_model=Todo, status_code=status.HTTP_201_CREATED)
+def create_todo(
+    todo: TodoCreate,
+    db: Session = Depends(get_db)
+):
+    """
+    Create new todo.
+    """
+    return todo_crud.create_todo(db=db, todo=todo)
+
+
+@router.get("/todos/{todo_id}", response_model=Todo)
+def read_todo(
+    todo_id: int,
+    db: Session = Depends(get_db)
+):
+    """
+    Get todo by ID.
+    """
+    db_todo = todo_crud.get_todo(db, todo_id=todo_id)
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@router.put("/todos/{todo_id}", response_model=Todo)
+def update_todo(
+    todo_id: int,
+    todo: TodoUpdate,
+    db: Session = Depends(get_db)
+):
+    """
+    Update a todo.
+    """
+    db_todo = todo_crud.update_todo(db, todo_id=todo_id, todo=todo)
+    if db_todo is None:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return db_todo
+
+
+@router.delete("/todos/{todo_id}", status_code=status.HTTP_204_NO_CONTENT)
+def delete_todo(
+    todo_id: int,
+    db: Session = Depends(get_db)
+):
+    """
+    Delete a todo.
+    """
+    deleted = todo_crud.delete_todo(db, todo_id=todo_id)
+    if not deleted:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return None

app/core/__init__.py

@@ -0,0 +1 @@
+# This file makes the core directory a Python package

app/core/config.py

@@ -0,0 +1,15 @@
+from pydantic import BaseSettings
+from pathlib import Path
+
+
+class Settings(BaseSettings):
+    PROJECT_NAME: str = "Todo API"
+    API_V1_STR: str = "/api/v1"
+    
+    # Database settings
+    DB_DIR = Path("/app") / "storage" / "db"
+    DB_DIR.mkdir(parents=True, exist_ok=True)
+    SQLALCHEMY_DATABASE_URL: str = f"sqlite:///{DB_DIR}/db.sqlite"
+    
+
+settings = Settings()

app/crud/__init__.py

@@ -0,0 +1 @@
+# This file makes the crud directory a Python package

app/crud/todo.py

@@ -0,0 +1,49 @@
+from typing import List, Optional
+from sqlalchemy.orm import Session
+
+from app.models.todo import Todo
+from app.schemas.todo import TodoCreate, TodoUpdate
+
+
+def get_todo(db: Session, todo_id: int) -> Optional[Todo]:
+    return db.query(Todo).filter(Todo.id == todo_id).first()
+
+
+def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]:
+    return db.query(Todo).offset(skip).limit(limit).all()
+
+
+def create_todo(db: Session, todo: TodoCreate) -> Todo:
+    db_todo = Todo(
+        title=todo.title,
+        description=todo.description,
+        completed=todo.completed
+    )
+    db.add(db_todo)
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+def update_todo(db: Session, todo_id: int, todo: TodoUpdate) -> Optional[Todo]:
+    db_todo = get_todo(db, todo_id)
+    if not db_todo:
+        return None
+    
+    update_data = todo.dict(exclude_unset=True)
+    for field, value in update_data.items():
+        setattr(db_todo, field, value)
+    
+    db.commit()
+    db.refresh(db_todo)
+    return db_todo
+
+
+def delete_todo(db: Session, todo_id: int) -> bool:
+    db_todo = get_todo(db, todo_id)
+    if not db_todo:
+        return False
+    
+    db.delete(db_todo)
+    db.commit()
+    return True

app/db/__init__.py

@@ -0,0 +1 @@
+# This file makes the db directory a Python package

app/db/base.py

@@ -0,0 +1,3 @@
+# Import all models here so Alembic can detect them
+from app.db.base_class import Base
+from app.models.todo import Todo

app/db/base_class.py

@@ -0,0 +1,3 @@
+from sqlalchemy.ext.declarative import declarative_base
+
+Base = declarative_base()

app/db/session.py

@@ -0,0 +1,18 @@
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+
+from app.core.config import settings
+
+engine = create_engine(
+    settings.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()

app/models/__init__.py

@@ -0,0 +1 @@
+# This file makes the models directory a Python package

app/models/todo.py

@@ -0,0 +1,15 @@
+from sqlalchemy import Column, Integer, String, Boolean, DateTime
+from sqlalchemy.sql import func
+
+from app.db.base_class import Base
+
+
+class Todo(Base):
+    __tablename__ = "todos"
+
+    id = Column(Integer, primary_key=True, index=True)
+    title = Column(String, index=True)
+    description = Column(String)
+    completed = Column(Boolean, default=False)
+    created_at = Column(DateTime(timezone=True), server_default=func.now())
+    updated_at = Column(DateTime(timezone=True), onupdate=func.now())

app/schemas/__init__.py

@@ -0,0 +1 @@
+# This file makes the schemas directory a Python package

app/schemas/todo.py

@@ -0,0 +1,32 @@
+from typing import Optional
+from datetime import datetime
+from pydantic import BaseModel
+
+
+class TodoBase(BaseModel):
+    title: str
+    description: Optional[str] = None
+    completed: bool = False
+
+
+class TodoCreate(TodoBase):
+    pass
+
+
+class TodoUpdate(BaseModel):
+    title: Optional[str] = None
+    description: Optional[str] = None
+    completed: Optional[bool] = None
+
+
+class TodoInDBBase(TodoBase):
+    id: int
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        orm_mode = True
+
+
+class Todo(TodoInDBBase):
+    pass

main.py

@@ -0,0 +1,16 @@
+from fastapi import FastAPI
+from app.api.endpoints import todo, health
+from app.core.config import settings
+
+app = FastAPI(
+    title=settings.PROJECT_NAME,
+    description="A simple Todo API",
+    version="0.1.0",
+)
+
+app.include_router(todo.router, prefix=settings.API_V1_STR, tags=["todos"])
+app.include_router(health.router, tags=["health"])
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)

requirements.txt

@@ -0,0 +1,6 @@
+fastapi==0.95.1
+uvicorn==0.22.0
+sqlalchemy==2.0.12
+alembic==1.10.4
+pydantic==1.10.7
+python-dotenv==1.0.0