FastAPI

Overview

FastAPI is a modern, high-performance Python web framework for building APIs. It features automatic interactive documentation, type hints validation, and async support out of the box.

Quick Start

git clone https://<git-server>/<username>/<repo-name>.git
cd <repo-name>

pip install -r requirements.txt

uvicorn app.main:app --reload

git add .
git commit -m "Initial setup"
git push origin main

Local Development with Docker

If you don't have Python installed locally, you can use Docker to run your FastAPI application.

Running Commands with Docker

# Install dependencies
docker run --rm -v $(pwd):/app -w /app python:3.12 pip install -r requirements.txt

# Run development server
docker run --rm -v $(pwd):/app -w /app -p 8000:8000 python:3.12 sh -c "pip install -r requirements.txt && uvicorn app.main:app --host 0.0.0.0 --reload"

Database Configuration

The NStrim platform provides you with a MySQL/MariaDB database. Configure your connection in the .env file or directly in your database configuration module.

DATABASE_URL=mysql+pymysql://<username>:<password>@db.<session-domain>:3306/<username>

Project Structure

├── app/
│   ├── main.py                # FastAPI application entry point
│   ├── routers/               # Route modules
│   ├── models/                # SQLAlchemy models
│   ├── schemas/               # Pydantic schemas
│   └── database.py            # Database connection
├── templates/                 # Jinja2 templates
├── static/                    # CSS, JS, images
├── requirements.txt           # Python dependencies
└── Dockerfile                 # Docker config
        

Common Tasks

Creating an API Endpoint

from fastapi import APIRouter

router = APIRouter()

@router.get("/users")
async def get_users():
    return [{"name": "Alice"}, {"name": "Bob"}]

@router.post("/users")
async def create_user(name: str, email: str):
    return {"name": name, "email": email}

Using SQLAlchemy

from sqlalchemy import Column, Integer, String
from app.database import Base

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String(100))
    email = Column(String(255), unique=True)

Pydantic Schema for Validation

from pydantic import BaseModel

class UserCreate(BaseModel):
    name: str
    email: str

class UserResponse(BaseModel):
    id: int
    name: str
    email: str

    class Config:
        from_attributes = True

Useful Commands

Troubleshooting

Deployment Workflow