Použijte mssql-python s FastAPI

FastAPI je moderní Python webový framework určený pro tvorbu API. Ve spojení s mssql-python můžete vytvářet vysoce výkonná REST API podporovaná Microsoft SQL a Azure SQL Database.

Předpoklady

  • Python 3.10 nebo novější.
  • Balíčky mssql-python, fastapi, uvicorn, pydantic a PyJWT. Vše nainstalujte pomocí pip install fastapi uvicorn mssql-python pydantic pyjwt.
  • Nainstalujte požadavky specifické pro jednorázový operační systém. Uživatelé Windows mohou tento krok přeskočit. Pro úplné podrobnosti o platformě viz Instalace mssql-python.
    apk add libtool krb5-libs krb5-dev

Vytvoření databáze SQL

Vytvořte nebo se připojte k SQL databázi na jedné z následujících platforem:

Příklady v tomto článku využívají databázi AdventureWorksLT , konkrétně tabulku SalesLT.Product . Pokud nemáte AdventureWorksLT nainstalovaný, podívejte se na ukázkové databáze AdventureWorks.

Nastavení projektu

Vytvoření virtuálního prostředí

Vytvořte a aktivujte virtuální prostředí, aby balíčky tohoto projektu zůstaly izolované od ostatních instalací Python. Tento krok také zabraňuje běžnému problému instalace balíčků do jednoho interpreteru při spuštění aplikace nebo testů s jiným.

py -m venv .venv
.\.venv\Scripts\Activate.ps1

Po aktivaci prostředí python, pip a pytest všechny odkazují na stejný interpret. Spusť zbývající příkazy v tomto článku z aktivovaného prostředí.

Note

Na Windows na ARM vytvořte prostředí pomocí Arm64 verze Python, takže mssql-python jeho závislosti instalujte z předpřipravených koleček. Na počítači s více než jednou verzí Pythonu může py -m venv vybrat jinou verzi nebo architekturu, než očekáváte, proto to po aktivaci ověřte pomocí python -c "import sys, sysconfig; print(sys.version, sysconfig.get_platform())". Pokud se pip pokusí sestavit cryptography ze zdroje (chyba v sadě nástrojů Rust a OpenSSL), nejprve pomocí pip install --only-binary=:all: cryptography nainstalujte verzi z wheel balíčku a poté nainstalujte zbytek.

Nainstalujte závislosti

Nainstalujte požadované balíčky pomocí pip:

pip install fastapi uvicorn mssql-python pydantic pyjwt

Struktura projektu

Organizujte svůj projekt do samostatných modulů pro databáze, schémata a operace CRUD:

my_api/
├── main.py
├── database.py
├── models.py
├── schemas.py
├── crud.py
├── test_api.py
└── routers/
    └── products.py

Správa připojení k databázi

FastAPI využívá injekci závislostí k poskytování zdrojů, jako jsou databázová připojení, pro směrovací handlery. Vzor v této části vytváří správce kontextu, který otevře spojení, předá kurzor a automaticky zpracuje potvrzení, vrácení změn a uzavření.

Vytvořte database.py

Funkce get_connection_string() vytváří ODBC připojovací řetězec z konfiguračních hodnot. Správce kontextu get_db() i generátor get_db_dependency() se řídí stejným vzorcem: otevřít připojení, předat kurzor, při úspěchu potvrdit transakci, při chybě provést vrácení transakce a po dokončení vždy zavřít. FastAPI volá Depends()get_db_dependency() jednou na požadavek a spravuje jeho životní cyklus.

# database.py
import mssql_python
from contextlib import contextmanager
from typing import Generator

# Configuration
DATABASE_CONFIG = {
    "server": "<server>.database.windows.net",
    "database": "<database>",
}

def get_connection_string() -> str:
    """Build connection string from config."""
    return (
        f"Server={DATABASE_CONFIG['server']};"
        f"Database={DATABASE_CONFIG['database']};"
        "Authentication=ActiveDirectoryDefault;"
        "Encrypt=yes"
    )

Note

ActiveDirectoryDefault používá DefaultAzureCredential, která zkouší více poskytovatelů přihlašovacích údajů postupně. První spojení může být pomalé, protože SDK prochází řetězec, dokud nenajde funkčního poskytovatele. V produkci, pokud víte, jaký typ přihlašovacích údajů vaše prostředí používá, zadejte ho přímo (například ActiveDirectoryMSI pro spravovanou identitu), abyste se vyhnuli tzv. chain walk. Další informace naleznete v tématu ověřování Microsoft Entra.

@contextmanager
def get_db() -> Generator:
    """Database connection context manager for FastAPI dependency injection."""
    conn = mssql_python.connect(get_connection_string())
    cursor = conn.cursor()
    try:
        yield cursor
        conn.commit()
    except Exception:
        conn.rollback()
        raise
    finally:
        cursor.close()
        conn.close()

def get_db_dependency():
    """FastAPI dependency for database cursor."""
    conn = mssql_python.connect(get_connection_string())
    cursor = conn.cursor()
    try:
        yield cursor
        conn.commit()
    except Exception:
        conn.rollback()
        raise
    finally:
        cursor.close()
        conn.close()

Pydantické modely

Pydantické modely definují tvar a validační pravidla pro data požadavků a odpovědí. FastAPI používá tyto modely k analýze příchozího JSON, ověřování polních omezení a automatickému generování dokumentace OpenAPI.

Vytvořte schemas.py

Rozdělte schémata na Base, Create, Update a varianty odpovědí. Schéma Base obsahuje sdílená pole, Create z něj dědí pro operace vložení a Update označuje všechna pole jako volitelná pro částečné aktualizace.

# schemas.py
from pydantic import BaseModel, ConfigDict, EmailStr, Field
from typing import Optional
from datetime import datetime

# Product schemas
class ProductBase(BaseModel):
    name: str = Field(..., min_length=1, max_length=100)
    product_number: str = Field(..., min_length=1, max_length=25)
    price: float = Field(..., gt=0)
    color: Optional[str] = Field(None, max_length=50)
    size: Optional[str] = Field(None, max_length=50)
    category_id: Optional[int] = None

class ProductCreate(ProductBase):
    pass

class ProductUpdate(BaseModel):
    name: Optional[str] = Field(None, min_length=1, max_length=100)
    product_number: Optional[str] = Field(None, min_length=1, max_length=25)
    price: Optional[float] = Field(None, gt=0)
    color: Optional[str] = Field(None, max_length=50)
    size: Optional[str] = Field(None, max_length=50)
    category_id: Optional[int] = None

class Product(ProductBase):
    id: int

    model_config = ConfigDict(from_attributes=True)

# Pagination
class PaginatedResponse(BaseModel):
    items: list
    total: int
    page: int
    page_size: int
    pages: int

operace CRUD

Zapouzdřete databázové dotazy do specializované třídy, aby obslužné funkce tras zůstaly jednoduché. Každá statická metoda vezme kurzor (injektovaný FastAPI) a provede jednu operaci pomocí parametrizovaných dotazů (%(name)s zástupců se slovníkem hodnot), aby zabránila SQL injekci. Toto oddělení usnadňuje testování a opětovné použití obchodní logiky.

Vytvořte crud.py

# crud.py
from typing import Optional, List
from schemas import ProductCreate, ProductUpdate, Product

class ProductCRUD:
    """CRUD operations for products."""
    
    @staticmethod
    def get(cursor, product_id: int) -> Optional[dict]:
        cursor.execute("""
            SELECT ProductID, Name, ProductNumber, ListPrice, Color, Size
            FROM SalesLT.Product
            WHERE ProductID = %(id)s
        """, {"id": product_id})
        
        row = cursor.fetchone()
        if row:
            return {
                "id": row.ProductID,
                "name": row.Name,
                "product_number": row.ProductNumber,
                "price": float(row.ListPrice),
                "color": row.Color,
                "size": row.Size
            }
        return None
    
    @staticmethod
    def get_all(cursor, skip: int = 0, limit: int = 100) -> List[dict]:
        cursor.execute("""
            SELECT ProductID, Name, ProductNumber, ListPrice, Color, Size
            FROM SalesLT.Product
            ORDER BY ProductID
            OFFSET %(skip)s ROWS
            FETCH NEXT %(limit)s ROWS ONLY
        """, {"skip": skip, "limit": limit})
        
        return [{
            "id": row.ProductID,
            "name": row.Name,
            "product_number": row.ProductNumber,
            "price": float(row.ListPrice),
            "color": row.Color,
            "size": row.Size
        } for row in cursor.fetchall()]
    
    @staticmethod
    def count(cursor) -> int:
        cursor.execute("SELECT COUNT(*) FROM SalesLT.Product")
        return cursor.fetchval()
    
    @staticmethod
    def create(cursor, product: ProductCreate) -> dict:
        cursor.execute("""
            INSERT INTO SalesLT.Product (Name, ProductNumber, ListPrice, Color, Size, ProductCategoryID, StandardCost, SellStartDate)
            OUTPUT INSERTED.ProductID, INSERTED.Name, INSERTED.ProductNumber,
                   INSERTED.ListPrice, INSERTED.Color, INSERTED.Size
            VALUES (%(name)s, %(product_number)s, %(price)s, %(color)s, %(size)s, %(category_id)s, 0, GETDATE())
        """, {
            "name": product.name,
            "product_number": product.product_number,
            "price": product.price,
            "color": product.color,
            "size": product.size,
            "category_id": product.category_id
        })
        
        row = cursor.fetchone()
        return {
            "id": row.ProductID,
            "name": row.Name,
            "product_number": row.ProductNumber,
            "price": float(row.ListPrice),
            "color": row.Color,
            "size": row.Size
        }
    
    @staticmethod
    def update(cursor, product_id: int, product: ProductUpdate) -> Optional[dict]:
        # Build dynamic update
        updates = []
        params = {"id": product_id}
        
        if product.name is not None:
            updates.append("Name = %(name)s")
            params["name"] = product.name
        if product.product_number is not None:
            updates.append("ProductNumber = %(product_number)s")
            params["product_number"] = product.product_number
        if product.price is not None:
            updates.append("ListPrice = %(price)s")
            params["price"] = product.price
        if product.category_id is not None:
            updates.append("ProductCategoryID = %(category_id)s")
            params["category_id"] = product.category_id
        
        if not updates:
            return ProductCRUD.get(cursor, product_id)
        
        cursor.execute(f"""
            UPDATE SalesLT.Product SET {', '.join(updates)}
            OUTPUT INSERTED.ProductID, INSERTED.Name, INSERTED.ProductNumber,
                   INSERTED.ListPrice, INSERTED.Color, INSERTED.Size
            WHERE ProductID = %(id)s
        """, params)
        
        row = cursor.fetchone()
        if row:
            return {
                "id": row.ProductID,
                "name": row.Name,
                "product_number": row.ProductNumber,
                "price": float(row.ListPrice),
                "color": row.Color,
                "size": row.Size
            }
        return None
    
    @staticmethod
    def delete(cursor, product_id: int) -> bool:
        cursor.execute("""
            DELETE FROM SalesLT.Product WHERE ProductID = %(id)s
        """, {"id": product_id})
        return cursor.rowcount > 0
    
    @staticmethod
    def search(cursor, query: str, skip: int = 0, limit: int = 100) -> List[dict]:
        cursor.execute("""
            SELECT ProductID, Name, ProductNumber, ListPrice, Color, Size
            FROM SalesLT.Product
            WHERE Name LIKE %(query)s OR ProductNumber LIKE %(query)s
            ORDER BY ProductID
            OFFSET %(skip)s ROWS
            FETCH NEXT %(limit)s ROWS ONLY
        """, {"query": f"%{query}%", "skip": skip, "limit": limit})
        
        return [{
            "id": row.ProductID,
            "name": row.Name,
            "product_number": row.ProductNumber,
            "price": float(row.ListPrice),
            "color": row.Color,
            "size": row.Size
        } for row in cursor.fetchall()]

Aplikace FastAPI

Vytvořte main.py

Hlavní modul vše zapojuje dohromady. Každá trasa deklaruje cursor = Depends(get_db_dependency), což říká FastAPI, aby zavolal generátor, předal výsledný kurzor obslužníkovi a následně ho vyčistil. FastAPI také ověřuje těla požadavků podle vašich schémat Pydantic ještě před spuštěním obslužné funkce.

# main.py
from fastapi import FastAPI, HTTPException, Depends, Query
from typing import List
from database import get_db_dependency
from schemas import Product, ProductCreate, ProductUpdate, PaginatedResponse
from crud import ProductCRUD

app = FastAPI(
    title="Product API",
    description="REST API for products using mssql-python",
    version="1.0.0"
)

@app.get("/")
def root():
    return {"message": "Product API", "docs": "/docs"}

@app.get("/products", response_model=PaginatedResponse)
def list_products(
    page: int = Query(1, ge=1),
    page_size: int = Query(10, ge=1, le=100),
    cursor = Depends(get_db_dependency)
):
    """List all products with pagination."""
    skip = (page - 1) * page_size
    items = ProductCRUD.get_all(cursor, skip=skip, limit=page_size)
    total = ProductCRUD.count(cursor)
    
    return {
        "items": items,
        "total": total,
        "page": page,
        "page_size": page_size,
        "pages": (total + page_size - 1) // page_size
    }

@app.get("/products/{product_id}", response_model=Product)
def get_product(product_id: int, cursor = Depends(get_db_dependency)):
    """Get a specific product by ID."""
    product = ProductCRUD.get(cursor, product_id)
    if not product:
        raise HTTPException(status_code=404, detail="Product not found")
    return product

@app.post("/products", response_model=Product, status_code=201)
def create_product(product: ProductCreate, cursor = Depends(get_db_dependency)):
    """Create a new product."""
    return ProductCRUD.create(cursor, product)

@app.put("/products/{product_id}", response_model=Product)
def update_product(
    product_id: int,
    product: ProductUpdate,
    cursor = Depends(get_db_dependency)
):
    """Update an existing product."""
    updated = ProductCRUD.update(cursor, product_id, product)
    if not updated:
        raise HTTPException(status_code=404, detail="Product not found")
    return updated

@app.delete("/products/{product_id}", status_code=204)
def delete_product(product_id: int, cursor = Depends(get_db_dependency)):
    """Delete a product."""
    if not ProductCRUD.delete(cursor, product_id):
        raise HTTPException(status_code=404, detail="Product not found")

@app.get("/products/search/", response_model=List[Product])
def search_products(
    q: str = Query(..., min_length=1),
    page: int = Query(1, ge=1),
    page_size: int = Query(10, ge=1, le=100),
    cursor = Depends(get_db_dependency)
):
    """Search products by name or product number."""
    skip = (page - 1) * page_size
    return ProductCRUD.search(cursor, q, skip=skip, limit=page_size)

# Health check endpoint
@app.get("/health")
def health_check(cursor = Depends(get_db_dependency)):
    """Check database connectivity."""
    try:
        cursor.execute("SELECT 1")
        return {"status": "healthy", "database": "connected"}
    except Exception as e:
        raise HTTPException(status_code=503, detail=f"Database unhealthy: {str(e)}")

Spuštění aplikace

uvicorn main:app --reload --host 0.0.0.0 --port 8000

Zpracování chyb

FastAPI vám umožňuje registrovat globální obslužné nástroje výjimek pro konkrétní typy výjimek. Když zachytíte mssql_python.DatabaseError a mssql_python.IntegrityError, FastAPI vrací strukturované JSON chyby s odpovídajícími HTTP stavovými kódy místo obecných odpovědí 500.

Globální obsluha výjimek

Přidejte tyto handlery do main.py, hned za řádkem app = FastAPI(...) . FastAPI spustí odpovídající handler vždy, když trasa vyvolá tento typ výjimky, takže nepotřebujete try/except blok v každé trase.

# main.py
from fastapi import Request
from fastapi.responses import JSONResponse
import mssql_python

@app.exception_handler(mssql_python.DatabaseError)
async def database_exception_handler(request: Request, exc: mssql_python.DatabaseError):
    """Handle database errors globally."""
    return JSONResponse(
        status_code=500,
        content={"detail": "Database error occurred", "type": "database_error"}
    )

@app.exception_handler(mssql_python.IntegrityError)
async def integrity_exception_handler(request: Request, exc: mssql_python.IntegrityError):
    """Handle integrity constraint violations."""
    error_msg = str(exc)
    
    if "UNIQUE" in error_msg:
        return JSONResponse(
            status_code=409,
            content={"detail": "Resource already exists", "type": "duplicate_error"}
        )
    elif "FOREIGN KEY" in error_msg:
        return JSONResponse(
            status_code=400,
            content={"detail": "Referenced resource not found", "type": "reference_error"}
        )
    
    return JSONResponse(
        status_code=400,
        content={"detail": "Data integrity error", "type": "integrity_error"}
    )

Note

Smazání produktu, na který se ostatní řádky stále odkazují, zvyšuje mssql_python.IntegrityError omezení cizího klíče a handler vrací hodnotu 400 místo odstranění řádku. Ve vzorku AdventureWorksLT je na většinu produktů v SalesLT.Product odkazováno pomocí SalesLT.SalesOrderDetail, takže DELETE u nich záměrně selhává. Chcete-li otestovat úspěšné odstranění, vytvořte produkt pomocí POST /products a ten odstraňte, nebo nejprve odstraňte řádky, které na něj odkazují.

Sdílení připojení

Bez poolování spojení každý požadavek otevírá a uzavírá TCP spojení s Microsoft SQL, což přidává latenci. Sdružování připojení udržuje sadu volných připojení připravených k opětovnému použití. Zavolejte mssql_python.pooling() jednou při startu. Když je pooling zapnutý, IN conn.close() vrací spojení do poolu místo toho, get_db_dependency() aby ho skutečně zavřel.

Rozšířený databázový modul

Povolte pooling voláním mssql_python.pooling() při spuštění a nastavte ho s vhodnou maximální velikostí a časovým limitem:

# database.py with connection pooling
import mssql_python
from contextlib import contextmanager
import os

# Configure pool
mssql_python.pooling(max_size=20, idle_timeout=300)

DATABASE_URL = os.getenv(
    "DATABASE_URL",
    "Server=<server>.database.windows.net;Database=<database>;"
    "Authentication=ActiveDirectoryDefault;Encrypt=yes"
)

def get_db_dependency():
    """FastAPI dependency with connection pooling."""
    conn = mssql_python.connect(DATABASE_URL)
    cursor = conn.cursor()
    try:
        yield cursor
        conn.commit()
    except Exception:
        conn.rollback()
        raise
    finally:
        cursor.close()
        conn.close()  # Returns to pool

middleware pro ověřování

Přístup k databázi můžete kombinovat s autentizací tím, že řetězíte závislosti FastAPI. Následující příklad ověřuje nosič tokenu JWT, vyhledá záznam o odpovídající osobě v databázi AdventureWorksLT a zpřístupní výsledek chráněným trasám.

# auth.py
from fastapi import Depends, HTTPException
from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
import jwt

security = HTTPBearer()

def get_current_user(
    credentials: HTTPAuthorizationCredentials = Depends(security),
    cursor = Depends(get_db_dependency)
):
    """Validate JWT and return the matching AdventureWorksLT person."""
    try:
        token = credentials.credentials
        # Replace with a strong secret loaded from environment variables
        payload = jwt.decode(token, "your-secret-key", algorithms=["HS256"])
        person_id = int(payload.get("sub"))
        
        if not person_id:
            raise HTTPException(status_code=401, detail="Invalid token")
        
        cursor.execute("""
            SELECT BusinessEntityID, FirstName, LastName
            FROM Person.Person
            WHERE BusinessEntityID = %(id)s
        """, {"id": person_id})
        
        person = cursor.fetchone()
        if not person:
            raise HTTPException(status_code=401, detail="User not found")
        
        return {
            "id": person.BusinessEntityID,
            "first_name": person.FirstName,
            "last_name": person.LastName
        }
        
    except (TypeError, ValueError):
        raise HTTPException(status_code=401, detail="Invalid token subject")
    except jwt.ExpiredSignatureError:
        raise HTTPException(status_code=401, detail="Token expired")
    except jwt.InvalidTokenError:
        raise HTTPException(status_code=401, detail="Invalid token")

# Protected endpoint
@app.get("/me")
def get_me(current_user: dict = Depends(get_current_user)):
    return current_user

Testing

FastAPI poskytuje TestClient postavený na httpx, který odesílá požadavky vaší aplikaci bez nutnosti spouštět skutečný HTTP server. Pište testy pomocí pytest, abyste ověřili trasy, stavové kódy a struktury odpovědí.

Před spuštěním testů v této části nainstalujte testovací závislosti:

pip install pytest httpx

Note

Pokud používáte nejnovější verzi Starlette nebo nastavujete nové prostředí, upřednostněte httpx2 před httpx. Nedávné verze Starlette používají httpx2 pro TestClient a zobrazují upozornění na zastarání, když je nainstalován pouze httpx. Nainstalujte ho pomocí pip install pytest httpx2.

Testovací nastavení

Vytvořte testovací soubor, který používá TestClient k ověření chování trasy a schémat reakcí:

# test_api.py
from fastapi.testclient import TestClient
from main import app
import uuid
import pytest

client = TestClient(app)

def test_list_products():
    response = client.get("/products")
    assert response.status_code == 200
    data = response.json()
    assert "items" in data
    assert "total" in data

def test_create_product():
    suffix = uuid.uuid4().hex[:8]
    name = f"Test Product {suffix}"
    product_data = {
        "name": name,
        "product_number": f"TEST-{suffix}",
        "price": 19.99,
        "color": "Red",
        "size": "M",
        "category_id": 1
    }
    response = client.post("/products", json=product_data)
    assert response.status_code == 201
    data = response.json()
    assert data["name"] == name
    assert data["price"] == 19.99

def test_get_product_not_found():
    response = client.get("/products/99999")
    assert response.status_code == 404

def test_health_check():
    response = client.get("/health")
    assert response.status_code == 200
    assert response.json()["status"] == "healthy"

Spusťte testy pomocí pytest v kořenovém adresáři projektu, ve stejném adresáři jako main.py:

pytest

Tyto testy běží na vaší živé databázi místo mocků, takže test_create_product vloží skutečný řádek do SalesLT.Product. V AdventureWorksLT mají Name i ProductNumber jedinečná omezení, takže test při každém spuštění generuje pro každý z nich jedinečnou hodnotu. Pokud tyto hodnoty místo toho zakódujete napevno, test při druhém spuštění s konfliktem selže, pokud nejdřív řádek nesmažete.

Konfigurace nasazení

Použijte v Pydanticu BaseSettings k načtení konfigurace z proměnných prostředí a ze souborů .env. Tento přístup udržuje tajemství mimo zdrojový kód a usnadňuje přechod mezi prostředími. Nainstalujte balíček nastavení pomocí pip install pydantic-settings.

Proměnné prostředí

Vytvořte modul nastavení, který načítá konfiguraci z proměnných prostředí, což vám umožní spravovat tajemství a hodnoty specifické pro nasazení mimo váš kód:

# config.py
from pydantic_settings import BaseSettings, SettingsConfigDict

class Settings(BaseSettings):
    database_server: str = "<server>.database.windows.net"
    database_name: str = "<database>"
    pool_size: int = 10

    model_config = SettingsConfigDict(env_file=".env")

settings = Settings()

def get_connection_string() -> str:
    return (
        f"Server={settings.database_server};"
        f"Database={settings.database_name};"
        "Authentication=ActiveDirectoryDefault;"
        "Encrypt=yes"
    )

Pak aktualizujte database.py, aby importoval get_connection_string z config namísto definování vlastní kopie. Odstraněním duplicitní funkce zajistíte, že aplikace čte nastavení připojení z jednoho zdroje.

# database.py
from config import get_connection_string

Související obsah

  • Last updated on