diff --git a/README.md b/README.md index e8acfba..638800e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,122 @@ -# FastAPI Application +# REST API Service -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +A REST API service built with FastAPI, featuring user management, SQLite database, and comprehensive API documentation. + +## Features + +- **FastAPI Framework**: Modern, fast web framework for building APIs +- **SQLite Database**: Lightweight, file-based database with SQLAlchemy ORM +- **User Management**: Complete CRUD operations for user entities +- **Database Migrations**: Alembic integration for database schema management +- **API Documentation**: Auto-generated OpenAPI/Swagger documentation +- **CORS Support**: Cross-Origin Resource Sharing enabled for all origins +- **Health Check**: Built-in health monitoring endpoint +- **Code Quality**: Ruff linting and formatting + +## Project Structure + +``` +├── main.py # FastAPI application entry point +├── requirements.txt # Python dependencies +├── pyproject.toml # Ruff configuration +├── alembic.ini # Alembic configuration +├── alembic/ # Database migrations +│ ├── versions/ # Migration files +│ └── env.py # Alembic environment +└── app/ + ├── api/ + │ └── v1/ + │ ├── api.py # API router aggregation + │ └── endpoints/ # API endpoints + │ └── users.py + ├── crud/ # Database operations + │ └── user.py + ├── db/ # Database configuration + │ ├── base.py # SQLAlchemy base + │ └── session.py # Database session + ├── models/ # Database models + │ └── user.py + └── schemas/ # Pydantic schemas + └── user.py +``` + +## API Endpoints + +### Base Endpoints +- `GET /` - Service information and links +- `GET /health` - Health check endpoint +- `GET /docs` - Interactive API documentation (Swagger UI) +- `GET /redoc` - Alternative API documentation (ReDoc) +- `GET /openapi.json` - OpenAPI specification + +### User Management +- `GET /api/v1/users/` - List all users (with pagination) +- `GET /api/v1/users/{user_id}` - Get user by ID +- `POST /api/v1/users/` - Create new user +- `PUT /api/v1/users/{user_id}` - Update user +- `DELETE /api/v1/users/{user_id}` - Delete user + +## Installation + +1. Install dependencies: +```bash +pip install -r requirements.txt +``` + +2. Run database migrations: +```bash +alembic upgrade head +``` + +3. Start the server: +```bash +uvicorn main:app --reload +``` + +The API will be available at `http://localhost:8000` + +## Environment Variables + +No environment variables are required for basic operation. The application uses SQLite database stored in `/app/storage/db/db.sqlite`. + +## Development + +### Code Quality +Run linting and formatting: +```bash +ruff check --fix . +``` + +### Database Migrations +Create a new migration: +```bash +alembic revision -m "Description of changes" +``` + +Apply migrations: +```bash +alembic upgrade head +``` + +## API Usage Examples + +### Create a User +```bash +curl -X POST "http://localhost:8000/api/v1/users/" \ + -H "Content-Type: application/json" \ + -d '{ + "email": "user@example.com", + "full_name": "John Doe", + "password": "secretpassword" + }' +``` + +### Get All Users +```bash +curl "http://localhost:8000/api/v1/users/" +``` + +### Health Check +```bash +curl "http://localhost:8000/health" +``` diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..bb932f7 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,109 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# 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 +# 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 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 + +# 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 + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix 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/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..37fc71a --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,82 @@ +import sys +from logging.config import fileConfig +from pathlib import Path + +from sqlalchemy import engine_from_config, pool + +from alembic import context + +# Add the project root to the Python path +sys.path.append(str(Path(__file__).parent.parent)) + +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: + 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() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..37d0cac --- /dev/null +++ b/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() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} \ No newline at end of file diff --git a/alembic/versions/001_initial_migration.py b/alembic/versions/001_initial_migration.py new file mode 100644 index 0000000..4029755 --- /dev/null +++ b/alembic/versions/001_initial_migration.py @@ -0,0 +1,41 @@ +"""Initial migration + +Revision ID: 001 +Revises: +Create Date: 2024-01-01 12:00:00.000000 + +""" +import sqlalchemy as sa + +from alembic import op + +# revision identifiers, used by Alembic. +revision = '001' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('users', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('email', sa.String(), nullable=False), + sa.Column('full_name', sa.String(), nullable=False), + sa.Column('hashed_password', sa.String(), nullable=False), + sa.Column('is_active', sa.Boolean(), 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_users_email'), 'users', ['email'], unique=True) + op.create_index(op.f('ix_users_id'), 'users', ['id'], unique=False) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_users_id'), table_name='users') + op.drop_index(op.f('ix_users_email'), table_name='users') + op.drop_table('users') + # ### end Alembic commands ### 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/v1/__init__.py b/app/api/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/v1/api.py b/app/api/v1/api.py new file mode 100644 index 0000000..cd1b13c --- /dev/null +++ b/app/api/v1/api.py @@ -0,0 +1,6 @@ +from fastapi import APIRouter + +from app.api.v1.endpoints import users + +api_router = APIRouter() +api_router.include_router(users.router, prefix="/users", tags=["users"]) diff --git a/app/api/v1/endpoints/__init__.py b/app/api/v1/endpoints/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/api/v1/endpoints/users.py b/app/api/v1/endpoints/users.py new file mode 100644 index 0000000..553275a --- /dev/null +++ b/app/api/v1/endpoints/users.py @@ -0,0 +1,54 @@ + +from fastapi import APIRouter, Depends, HTTPException, status +from sqlalchemy.orm import Session + +from app.crud.user import ( + create_user, + delete_user, + get_user, + get_user_by_email, + get_users, + update_user, +) +from app.db.session import get_db +from app.schemas.user import User, UserCreate, UserUpdate + +router = APIRouter() + +@router.get("/", response_model=list[User]) +def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): + """Get all users with pagination""" + users = get_users(db, skip=skip, limit=limit) + return users + +@router.get("/{user_id}", response_model=User) +def read_user(user_id: int, db: Session = Depends(get_db)): + """Get a specific user by ID""" + db_user = get_user(db, user_id=user_id) + if db_user is None: + raise HTTPException(status_code=404, detail="User not found") + return db_user + +@router.post("/", response_model=User, status_code=status.HTTP_201_CREATED) +def create_user_endpoint(user: UserCreate, db: Session = Depends(get_db)): + """Create a new user""" + db_user = get_user_by_email(db, email=user.email) + if db_user: + raise HTTPException(status_code=400, detail="Email already registered") + return create_user(db=db, user=user) + +@router.put("/{user_id}", response_model=User) +def update_user_endpoint(user_id: int, user_update: UserUpdate, db: Session = Depends(get_db)): + """Update an existing user""" + db_user = update_user(db, user_id=user_id, user_update=user_update) + if db_user is None: + raise HTTPException(status_code=404, detail="User not found") + return db_user + +@router.delete("/{user_id}") +def delete_user_endpoint(user_id: int, db: Session = Depends(get_db)): + """Delete a user""" + success = delete_user(db, user_id=user_id) + if not success: + raise HTTPException(status_code=404, detail="User not found") + return {"message": "User deleted successfully"} diff --git a/app/crud/__init__.py b/app/crud/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/crud/user.py b/app/crud/user.py new file mode 100644 index 0000000..74f3d27 --- /dev/null +++ b/app/crud/user.py @@ -0,0 +1,55 @@ +from typing import Optional + +from passlib.context import CryptContext +from sqlalchemy.orm import Session + +from app.models.user import User +from app.schemas.user import UserCreate, UserUpdate + +pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") + +def get_password_hash(password: str) -> str: + return pwd_context.hash(password) + +def verify_password(plain_password: str, hashed_password: str) -> bool: + return pwd_context.verify(plain_password, hashed_password) + +def get_user(db: Session, user_id: int) -> Optional[User]: + return db.query(User).filter(User.id == user_id).first() + +def get_user_by_email(db: Session, email: str) -> Optional[User]: + return db.query(User).filter(User.email == email).first() + +def get_users(db: Session, skip: int = 0, limit: int = 100): + return db.query(User).offset(skip).limit(limit).all() + +def create_user(db: Session, user: UserCreate) -> User: + hashed_password = get_password_hash(user.password) + db_user = User( + email=user.email, + full_name=user.full_name, + hashed_password=hashed_password, + is_active=user.is_active + ) + db.add(db_user) + db.commit() + db.refresh(db_user) + return db_user + +def update_user(db: Session, user_id: int, user_update: UserUpdate) -> Optional[User]: + db_user = get_user(db, user_id) + if db_user: + update_data = user_update.dict(exclude_unset=True) + for field, value in update_data.items(): + setattr(db_user, field, value) + db.commit() + db.refresh(db_user) + return db_user + +def delete_user(db: Session, user_id: int) -> bool: + db_user = get_user(db, user_id) + if db_user: + db.delete(db_user) + db.commit() + return True + return False 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..860e542 --- /dev/null +++ b/app/db/base.py @@ -0,0 +1,3 @@ +from sqlalchemy.ext.declarative import declarative_base + +Base = declarative_base() diff --git a/app/db/session.py b/app/db/session.py new file mode 100644 index 0000000..b6eb1a9 --- /dev/null +++ b/app/db/session.py @@ -0,0 +1,23 @@ +from pathlib import Path + +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker + +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) + +def get_db(): + db = SessionLocal() + try: + yield db + finally: + db.close() diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/models/user.py b/app/models/user.py new file mode 100644 index 0000000..d8cb735 --- /dev/null +++ b/app/models/user.py @@ -0,0 +1,16 @@ +from sqlalchemy import Boolean, Column, DateTime, Integer, String +from sqlalchemy.sql import func + +from app.db.base import Base + + +class User(Base): + __tablename__ = "users" + + id = Column(Integer, primary_key=True, index=True) + email = Column(String, unique=True, index=True, nullable=False) + full_name = Column(String, nullable=False) + hashed_password = Column(String, nullable=False) + is_active = Column(Boolean, default=True) + created_at = Column(DateTime(timezone=True), server_default=func.now()) + updated_at = Column(DateTime(timezone=True), onupdate=func.now()) diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/app/schemas/user.py b/app/schemas/user.py new file mode 100644 index 0000000..9703a81 --- /dev/null +++ b/app/schemas/user.py @@ -0,0 +1,26 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel, EmailStr + + +class UserBase(BaseModel): + email: EmailStr + full_name: str + is_active: bool = True + +class UserCreate(UserBase): + password: str + +class UserUpdate(BaseModel): + email: Optional[EmailStr] = None + full_name: Optional[str] = None + is_active: Optional[bool] = None + +class User(UserBase): + id: int + created_at: datetime + updated_at: Optional[datetime] = None + + class Config: + from_attributes = True diff --git a/main.py b/main.py new file mode 100644 index 0000000..d19b8ec --- /dev/null +++ b/main.py @@ -0,0 +1,49 @@ + +from fastapi import FastAPI +from fastapi.middleware.cors import CORSMiddleware + +from app.api.v1.api import api_router +from app.db.base import Base +from app.db.session import engine + +# Create tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="REST API Service", + description="A REST API service built with FastAPI", + version="1.0.0", + openapi_url="/openapi.json", + docs_url="/docs", + redoc_url="/redoc", +) + +# CORS middleware +app.add_middleware( + CORSMiddleware, + allow_origins=["*"], + allow_credentials=True, + allow_methods=["*"], + allow_headers=["*"], +) + +# Include API router +app.include_router(api_router, prefix="/api/v1") + +@app.get("/") +async def root(): + return { + "title": "REST API Service", + "description": "A REST API service built with FastAPI", + "version": "1.0.0", + "documentation": "/docs", + "health_check": "/health" + } + +@app.get("/health") +async def health_check(): + return { + "status": "healthy", + "service": "REST API Service", + "version": "1.0.0" + } diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..ac7c343 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,25 @@ +[tool.ruff] +target-version = "py39" +line-length = 88 + +[tool.ruff.lint] +select = [ + "E", # pycodestyle errors + "W", # pycodestyle warnings + "F", # pyflakes + "I", # isort + "B", # flake8-bugbear + "C4", # flake8-comprehensions + "UP", # pyupgrade +] +ignore = [ + "E501", # line too long, handled by black + "B008", # do not perform function calls in argument defaults + "C901", # too complex +] + +[tool.ruff.lint.per-file-ignores] +"__init__.py" = ["F401"] + +[tool.ruff.lint.isort] +known-third-party = ["fastapi", "pydantic", "starlette"] \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7526f2c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +fastapi==0.104.1 +uvicorn[standard]==0.24.0 +sqlalchemy==2.0.23 +alembic==1.12.1 +python-multipart==0.0.6 +python-jose[cryptography]==3.3.0 +passlib[bcrypt]==1.7.4 +python-dotenv==1.0.0 +ruff==0.1.6 \ No newline at end of file