From 5c4ad74340ba4018de52819de2ad43f76b05b9e6 Mon Sep 17 00:00:00 2001 From: Automated Action Date: Sun, 18 May 2025 07:50:58 +0000 Subject: [PATCH] Create FastAPI project with user authentication and SQLite --- README.md | 106 +++++++++++++++++- alembic.ini | 103 +++++++++++++++++ alembic/env.py | 84 ++++++++++++++ alembic/script.py.mako | 24 ++++ .../a1b2c3d4e5f6_create_users_table.py | 57 ++++++++++ app/__init__.py | 4 + app/database.py | 31 +++++ app/models/__init__.py | 3 + app/models/user.py | 17 +++ app/routers/__init__.py | 3 + app/routers/users.py | 106 ++++++++++++++++++ app/schemas/__init__.py | 19 ++++ app/schemas/user.py | 49 ++++++++ app/utils.py | 64 +++++++++++ main.py | 30 +++++ requirements.txt | 14 +++ 16 files changed, 712 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/a1b2c3d4e5f6_create_users_table.py create mode 100644 app/__init__.py create mode 100644 app/database.py create mode 100644 app/models/__init__.py create mode 100644 app/models/user.py create mode 100644 app/routers/__init__.py create mode 100644 app/routers/users.py create mode 100644 app/schemas/__init__.py create mode 100644 app/schemas/user.py create mode 100644 app/utils.py create mode 100644 main.py create mode 100644 requirements.txt diff --git a/README.md b/README.md index e8acfba..ba1ea12 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,105 @@ -# FastAPI Application +# FastAPI REST API Service -This is a FastAPI application bootstrapped by BackendIM, the AI-powered backend generation platform. +This is a FastAPI-based REST API with user authentication, built with SQLite for data storage. + +## Features + +- User registration and authentication with JWT tokens +- FastAPI automatic Swagger documentation +- SQLAlchemy ORM for database operations +- Alembic migrations for database versioning +- Password hashing with bcrypt +- Health check endpoint + +## Getting Started + +### Prerequisites + +- Python 3.8+ +- SQLite + +### Installation + +1. Clone the repository: + +```bash +git clone +cd genericrestapiservice +``` + +2. Install the dependencies: + +```bash +pip install -r requirements.txt +``` + +3. Apply the database migrations: + +```bash +alembic upgrade head +``` + +4. Run the application: + +```bash +uvicorn main:app --reload +``` + +The API will be available at http://localhost:8000. + +## API Documentation + +Once the application is running, you can access the following documentation: + +- Swagger UI: http://localhost:8000/docs +- ReDoc: http://localhost:8000/redoc + +## API Endpoints + +### Health Check + +- `GET /health` - Check if the API is healthy + +### Users + +- `POST /users` - Register a new user +- `POST /users/token` - Get an access token (login) +- `GET /users/me` - Get the current authenticated user +- `GET /users/{user_id}` - Get a user by ID + +## Database + +The application uses SQLite as the database. The database file is stored at `/app/storage/db/db.sqlite`. + +### Migrations + +Database migrations are managed with Alembic. To apply migrations: + +```bash +alembic upgrade head +``` + +To create a new migration: + +```bash +alembic revision -m "description" +``` + +## Development + +### Code Structure + +- `app/` - Main application directory + - `models/` - SQLAlchemy models + - `schemas/` - Pydantic schemas + - `routers/` - FastAPI routers + - `utils.py` - Utility functions + - `database.py` - Database configuration +- `alembic/` - Alembic migrations +- `main.py` - Application entry point + +### Running Tests + +```bash +pytest +``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..e16ae26 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,103 @@ +# 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 + +# 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 alembic/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:alembic/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 + +# SQLite URL - using absolute path as required +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/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..b414ebd --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,84 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from app.models 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 +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +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, # Use batch mode for SQLite + compare_type=True, + ) + + 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/a1b2c3d4e5f6_create_users_table.py b/alembic/versions/a1b2c3d4e5f6_create_users_table.py new file mode 100644 index 0000000..069fee7 --- /dev/null +++ b/alembic/versions/a1b2c3d4e5f6_create_users_table.py @@ -0,0 +1,57 @@ +"""create users table + +Revision ID: a1b2c3d4e5f6 +Revises: +Create Date: 2023-01-01 00:00:00.000000 + +""" + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = "a1b2c3d4e5f6" +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # Create users table + op.create_table( + "users", + sa.Column("id", sa.Integer(), nullable=False), + sa.Column("email", sa.String(), nullable=False), + sa.Column("username", sa.String(), nullable=False), + sa.Column("hashed_password", sa.String(), nullable=False), + sa.Column("is_active", sa.Boolean(), nullable=True, default=True), + sa.Column( + "created_at", + sa.DateTime(), + server_default=sa.text("(CURRENT_TIMESTAMP)"), + nullable=False, + ), + sa.Column( + "updated_at", + sa.DateTime(), + server_default=sa.text("(CURRENT_TIMESTAMP)"), + nullable=False, + ), + sa.PrimaryKeyConstraint("id"), + ) + + # Create indexes + op.create_index(op.f("ix_users_id"), "users", ["id"], unique=False) + op.create_index(op.f("ix_users_email"), "users", ["email"], unique=True) + op.create_index(op.f("ix_users_username"), "users", ["username"], unique=True) + + +def downgrade() -> None: + # Drop indexes + op.drop_index(op.f("ix_users_username"), table_name="users") + op.drop_index(op.f("ix_users_email"), table_name="users") + op.drop_index(op.f("ix_users_id"), table_name="users") + + # Drop users table + op.drop_table("users") diff --git a/app/__init__.py b/app/__init__.py new file mode 100644 index 0000000..3092f0f --- /dev/null +++ b/app/__init__.py @@ -0,0 +1,4 @@ +# app package +"""Generic REST API Service package.""" + +__version__ = "0.1.0" diff --git a/app/database.py b/app/database.py new file mode 100644 index 0000000..0404fd2 --- /dev/null +++ b/app/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 for routes +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..b2e47e8 --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,3 @@ +from app.models.user import User + +__all__ = ["User"] diff --git a/app/models/user.py b/app/models/user.py new file mode 100644 index 0000000..06da051 --- /dev/null +++ b/app/models/user.py @@ -0,0 +1,17 @@ +from sqlalchemy import Boolean, Column, Integer, String +from sqlalchemy.sql import func +from sqlalchemy.types import DateTime + +from app.database import Base + + +class User(Base): + __tablename__ = "users" + + id = Column(Integer, primary_key=True, index=True) + email = Column(String, unique=True, index=True) + username = Column(String, unique=True, index=True) + hashed_password = Column(String) + 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()) diff --git a/app/routers/__init__.py b/app/routers/__init__.py new file mode 100644 index 0000000..0b4a4ec --- /dev/null +++ b/app/routers/__init__.py @@ -0,0 +1,3 @@ +from app.routers.users import router as users_router + +__all__ = ["users_router"] diff --git a/app/routers/users.py b/app/routers/users.py new file mode 100644 index 0000000..3b04323 --- /dev/null +++ b/app/routers/users.py @@ -0,0 +1,106 @@ +from datetime import timedelta + +from fastapi import APIRouter, Depends, HTTPException, status +from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm +from jose import JWTError, jwt +from sqlalchemy.orm import Session + +from app.database import get_db +from app.schemas.user import User, UserCreate, Token, TokenData +from app.utils import ( + ACCESS_TOKEN_EXPIRE_MINUTES, + ALGORITHM, + SECRET_KEY, + create_access_token, + create_user, + get_user, + get_user_by_email, + get_user_by_username, + verify_password, +) + +router = APIRouter( + prefix="/users", + tags=["users"], +) + +oauth2_scheme = OAuth2PasswordBearer(tokenUrl="users/token") + + +async def get_current_user( + token: str = Depends(oauth2_scheme), db: Session = Depends(get_db) +): + """Get the current user from the JWT token.""" + credentials_exception = HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="Could not validate credentials", + headers={"WWW-Authenticate": "Bearer"}, + ) + try: + payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM]) + username: str = payload.get("sub") + if username is None: + raise credentials_exception + token_data = TokenData(username=username) + except JWTError: + raise credentials_exception + user = get_user_by_username(db, username=token_data.username) + if user is None: + raise credentials_exception + return user + + +@router.post("/", response_model=User, status_code=status.HTTP_201_CREATED) +async def register_user(user: UserCreate, db: Session = Depends(get_db)): + """Register a new user.""" + # Check if email already exists + db_user = get_user_by_email(db, email=user.email) + if db_user: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, detail="Email already registered" + ) + + # Check if username already exists + db_user = get_user_by_username(db, username=user.username) + if db_user: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, detail="Username already taken" + ) + + # Create user + return create_user(db, user.email, user.username, user.password) + + +@router.post("/token", response_model=Token) +async def login_for_access_token( + form_data: OAuth2PasswordRequestForm = Depends(), db: Session = Depends(get_db) +): + """Get an access token from username and password.""" + user = get_user_by_username(db, username=form_data.username) + if not user or not verify_password(form_data.password, user.hashed_password): + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="Incorrect username or password", + headers={"WWW-Authenticate": "Bearer"}, + ) + + access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES) + access_token = create_access_token( + data={"sub": user.username}, expires_delta=access_token_expires + ) + return {"access_token": access_token, "token_type": "bearer"} + + +@router.get("/me", response_model=User) +async def read_users_me(current_user: User = Depends(get_current_user)): + """Get the current authenticated user.""" + return current_user + + +@router.get("/{user_id}", response_model=User) +async def read_user(user_id: int, db: Session = Depends(get_db)): + """Get a 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 diff --git a/app/schemas/__init__.py b/app/schemas/__init__.py new file mode 100644 index 0000000..28822f6 --- /dev/null +++ b/app/schemas/__init__.py @@ -0,0 +1,19 @@ +from app.schemas.user import ( + User, + UserBase, + UserCreate, + UserInDB, + UserUpdate, + Token, + TokenData, +) + +__all__ = [ + "User", + "UserBase", + "UserCreate", + "UserInDB", + "UserUpdate", + "Token", + "TokenData", +] diff --git a/app/schemas/user.py b/app/schemas/user.py new file mode 100644 index 0000000..42dbb50 --- /dev/null +++ b/app/schemas/user.py @@ -0,0 +1,49 @@ +from datetime import datetime +from typing import Optional + +from pydantic import BaseModel, EmailStr + + +class UserBase(BaseModel): + email: EmailStr + username: str + is_active: Optional[bool] = True + + +class UserCreate(UserBase): + password: str + + +class UserUpdate(BaseModel): + email: Optional[EmailStr] = None + username: Optional[str] = None + password: Optional[str] = None + is_active: Optional[bool] = None + + +class UserInDB(UserBase): + id: int + hashed_password: str + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class User(UserBase): + id: int + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class Token(BaseModel): + access_token: str + token_type: str + + +class TokenData(BaseModel): + username: Optional[str] = None diff --git a/app/utils.py b/app/utils.py new file mode 100644 index 0000000..c0b41f1 --- /dev/null +++ b/app/utils.py @@ -0,0 +1,64 @@ +from datetime import datetime, timedelta +from typing import Optional + +from jose import jwt +from passlib.context import CryptContext +from pydantic import EmailStr +from sqlalchemy.orm import Session + +from app.models.user import User + +# Password hashing setup +pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") + +# JWT settings +SECRET_KEY = "your-secret-key-here" # Should be stored securely in env variables +ALGORITHM = "HS256" +ACCESS_TOKEN_EXPIRE_MINUTES = 30 + + +def verify_password(plain_password, hashed_password): + """Verify a password against a hashed password.""" + return pwd_context.verify(plain_password, hashed_password) + + +def get_password_hash(password): + """Hash a password.""" + return pwd_context.hash(password) + + +def create_access_token(data: dict, expires_delta: Optional[timedelta] = None): + """Create a JWT access token.""" + to_encode = data.copy() + if expires_delta: + expire = datetime.utcnow() + expires_delta + else: + expire = datetime.utcnow() + timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES) + to_encode.update({"exp": expire}) + encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM) + return encoded_jwt + + +def get_user(db: Session, user_id: int): + """Get a user by ID.""" + return db.query(User).filter(User.id == user_id).first() + + +def get_user_by_email(db: Session, email: EmailStr): + """Get a user by email.""" + return db.query(User).filter(User.email == email).first() + + +def get_user_by_username(db: Session, username: str): + """Get a user by username.""" + return db.query(User).filter(User.username == username).first() + + +def create_user(db: Session, email: EmailStr, username: str, password: str): + """Create a new user.""" + hashed_password = get_password_hash(password) + db_user = User(email=email, username=username, hashed_password=hashed_password) + db.add(db_user) + db.commit() + db.refresh(db_user) + return db_user diff --git a/main.py b/main.py new file mode 100644 index 0000000..c5b9cc4 --- /dev/null +++ b/main.py @@ -0,0 +1,30 @@ +from fastapi import FastAPI +import uvicorn + +from app.database import engine +from app.models import Base +from app.routers import users_router + +# Create database tables +Base.metadata.create_all(bind=engine) + +app = FastAPI( + title="Generic REST API Service", + description="A basic REST API service with user authentication", + version="0.1.0", + docs_url="/docs", + redoc_url="/redoc", +) + +# Include routers +app.include_router(users_router) + + +@app.get("/health", tags=["Health"]) +async def health(): + """Check if the API is healthy.""" + return {"status": "healthy"} + + +if __name__ == "__main__": + uvicorn.run("main:app", host="0.0.0.0", port=8000, reload=True) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..cad4197 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,14 @@ +fastapi>=0.104.0 +pydantic>=2.4.2 +pydantic-settings>=2.0.0 +uvicorn>=0.23.2 +sqlalchemy>=2.0.22 +alembic>=1.12.0 +python-jose>=3.3.0 +passlib>=1.7.4 +python-multipart>=0.0.6 +bcrypt>=4.0.1 +pytest>=7.4.0 +httpx>=0.24.1 +ruff>=0.0.292 +python-dotenv>=1.0.0 \ No newline at end of file