Create FastAPI Todo API application

- Set up project structure and requirements
- Create database models and connection
- Set up Alembic for migrations
- Implement CRUD operations for todos
- Build RESTful API endpoints
- Update README with project documentation

generated with BackendIM... (backend.im)

README.md

@@ -1,3 +1,68 @@
-# FastAPI Application
+# Todo API Application
 
-This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform.
+This is a FastAPI Todo API application with SQLite database that provides a complete CRUD functionality for managing todo items.
+
+## Features
+
+- Create, read, update, and delete todo items
+- RESTful API with proper HTTP status codes
+- SQLite database for storage
+- API documentation with Swagger and ReDoc
+- Alembic for database migrations
+
+## Project Structure
+
+```
+todoapiapplication/
+├── alembic/                  # Database migrations
+│   └── versions/             # Migration scripts
+├── api/                      # API implementation
+│   └── routes/               # API route handlers
+├── db/                       # Database configuration
+├── models/                   # SQLAlchemy ORM models
+├── schemas/                  # Pydantic schemas/models
+├── services/                 # Business logic layer
+├── tests/                    # Test files
+├── alembic.ini               # Alembic configuration
+├── main.py                   # Application entry point
+└── requirements.txt          # Project dependencies
+```
+
+## API Endpoints
+
+| Method | Endpoint      | Description          | Request Body    | Response            |
+|--------|---------------|----------------------|-----------------|---------------------|
+| GET    | /api/todos/   | Get all todos        | -               | List of todos       |
+| POST   | /api/todos/   | Create a new todo    | Todo object     | Created todo        |
+| GET    | /api/todos/id | Get a todo by ID     | -               | Todo object         |
+| PUT    | /api/todos/id | Update a todo by ID  | Todo object     | Updated todo        |
+| DELETE | /api/todos/id | Delete a todo by ID  | -               | No content (204)    |
+
+## Setup and Installation
+
+1. Clone the repository
+2. Install the dependencies: `pip install -r requirements.txt`
+3. Run the application: `uvicorn main:app --reload`
+4. The API will be available at: `http://localhost:8000`
+5. API documentation: `http://localhost:8000/docs` or `http://localhost:8000/redoc`
+
+## Database Migrations
+
+Migrations are handled by Alembic:
+
+```bash
+# Apply migrations
+alembic upgrade head
+
+# Create a new migration
+alembic revision -m "description"
+```
+
+## Todo Model
+
+- `id`: Integer (Primary Key)
+- `title`: String (Required)
+- `description`: String (Optional)
+- `completed`: Boolean (Default: False)
+- `created_at`: DateTime
+- `updated_at`: DateTime

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.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

alembic/env.py

@@ -0,0 +1,77 @@
+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 models.todo import Todo
+from db.database 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,36 @@
+"""create todos table
+
+Revision ID: 001
+Revises: 
+Create Date: 2025-05-11
+
+"""
+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=False),
+        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.func.now()),
+        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')

api/routes/todos.py

@@ -0,0 +1,73 @@
+from fastapi import APIRouter, Depends, HTTPException, status, Query
+from sqlalchemy.orm import Session
+from typing import List
+
+from db.database import get_db
+from schemas.todo import Todo, TodoCreate, TodoUpdate
+from services.todo import (
+    get_todos,
+    get_todo,
+    create_todo,
+    update_todo,
+    delete_todo,
+)
+
+router = APIRouter(
+    prefix="/todos",
+    tags=["todos"],
+    responses={404: {"description": "Not found"}},
+)
+
+
+@router.get("/", response_model=List[Todo])
+def read_todos(
+    skip: int = Query(0, ge=0, description="Skip the first N items"),
+    limit: int = Query(100, ge=1, le=100, description="Limit the number of items returned"),
+    db: Session = Depends(get_db)
+):
+    """
+    Get all todos with pagination.
+    """
+    todos = get_todos(db, skip=skip, limit=limit)
+    return todos
+
+
+@router.post("/", response_model=Todo, status_code=status.HTTP_201_CREATED)
+def create_new_todo(todo: TodoCreate, db: Session = Depends(get_db)):
+    """
+    Create a new todo.
+    """
+    return create_todo(db=db, todo=todo)
+
+
+@router.get("/{todo_id}", response_model=Todo)
+def read_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Get a specific todo by ID.
+    """
+    db_todo = 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("/{todo_id}", response_model=Todo)
+def update_existing_todo(todo_id: int, todo: TodoUpdate, db: Session = Depends(get_db)):
+    """
+    Update an existing todo.
+    """
+    db_todo = update_todo(db=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("/{todo_id}", status_code=status.HTTP_204_NO_CONTENT)
+def delete_existing_todo(todo_id: int, db: Session = Depends(get_db)):
+    """
+    Delete a todo.
+    """
+    success = delete_todo(db=db, todo_id=todo_id)
+    if not success:
+        raise HTTPException(status_code=404, detail="Todo not found")
+    return None

db/database.py

@@ -0,0 +1,31 @@
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from pathlib import Path
+
+# Create database directory
+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 engine
+engine = create_engine(
+    SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False}
+)
+
+# Create session factory
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+# Create base class for models
+Base = declarative_base()
+
+# Dependency to get DB session
+def get_db():
+    db = SessionLocal()
+    try:
+        yield db
+    finally:
+        db.close()

main.py

@@ -0,0 +1,33 @@
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+import uvicorn
+from api.routes import todos
+from db.database import Base, engine
+
+# Create tables
+Base.metadata.create_all(bind=engine)
+
+app = FastAPI(
+    title="Todo API",
+    description="A simple Todo API built with FastAPI and SQLite",
+    version="1.0.0"
+)
+
+# Configure CORS
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+# Include routers
+app.include_router(todos.router, prefix="/api")
+
+@app.get("/")
+def root():
+    return {"message": "Welcome to Todo API"}
+
+if __name__ == "__main__":
+    uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True)

models/todo.py

@@ -0,0 +1,14 @@
+from sqlalchemy import Boolean, Column, Integer, String, DateTime
+from sqlalchemy.sql import func
+from db.database 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())

requirements.txt

@@ -0,0 +1,6 @@
+fastapi==0.104.1
+uvicorn==0.24.0
+sqlalchemy==2.0.23
+pydantic==2.5.0
+alembic==1.12.1
+python-dotenv==1.0.0

schemas/todo.py

@@ -0,0 +1,32 @@
+from pydantic import BaseModel, Field
+from datetime import datetime
+from typing import Optional
+
+
+class TodoBase(BaseModel):
+    title: str = Field(..., title="The title of the todo", min_length=1)
+    description: Optional[str] = Field(None, title="The description of the todo")
+    completed: bool = Field(False, title="Whether the todo is completed")
+
+
+class TodoCreate(TodoBase):
+    pass
+
+
+class TodoUpdate(BaseModel):
+    title: Optional[str] = Field(None, title="The title of the todo", min_length=1)
+    description: Optional[str] = Field(None, title="The description of the todo")
+    completed: Optional[bool] = Field(None, title="Whether the todo is completed")
+
+
+class TodoInDB(TodoBase):
+    id: int
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        from_attributes = True
+
+
+class Todo(TodoInDB):
+    pass

services/todo.py

@@ -0,0 +1,55 @@
+from sqlalchemy.orm import Session
+from typing import List, Optional
+from models.todo import Todo
+from schemas.todo import TodoCreate, TodoUpdate
+
+
+def get_todos(db: Session, skip: int = 0, limit: int = 100) -> List[Todo]:
+    """
+    Get all todos with pagination
+    """
+    return db.query(Todo).offset(skip).limit(limit).all()
+
+
+def get_todo(db: Session, todo_id: int) -> Optional[Todo]:
+    """
+    Get a specific todo by ID
+    """
+    return db.query(Todo).filter(Todo.id == todo_id).first()
+
+
+def create_todo(db: Session, todo: TodoCreate) -> Todo:
+    """
+    Create a new todo
+    """
+    db_todo = Todo(**todo.dict())
+    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]:
+    """
+    Update an existing todo
+    """
+    db_todo = get_todo(db, todo_id)
+    if db_todo:
+        update_data = todo.dict(exclude_unset=True)
+        for key, value in update_data.items():
+            setattr(db_todo, key, value)
+        db.commit()
+        db.refresh(db_todo)
+    return db_todo
+
+
+def delete_todo(db: Session, todo_id: int) -> bool:
+    """
+    Delete a todo
+    """
+    db_todo = get_todo(db, todo_id)
+    if db_todo:
+        db.delete(db_todo)
+        db.commit()
+        return True
+    return False