REFERÊNCIA RÁPIDA FASTAPI
Operações de path, validação, dependências, auth, testes
Configuração
App Mínima
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello, World!"}
Executar a App
pip install "fastapi[standard]"
fastapi dev main.py # dev with auto-reload
fastapi run main.py # production
Recursos Principais
| Async native | async/await com ASGI (Uvicorn) |
| Auto docs | Swagger UI em /docs, ReDoc em /redoc |
| Type validation | Modelos Pydantic para requisição/resposta |
| OpenAPI | Schema OpenAPI gerado automaticamente |
| Dependency injection | Sistema DI embutido |
Operações de Path
Métodos HTTP
@app.get("/items")
@app.post("/items")
@app.put("/items/{item_id}")
@app.patch("/items/{item_id}")
@app.delete("/items/{item_id}")
Parâmetros de Path
@app.get("/users/{user_id}")
async def get_user(user_id: int):
return {"user_id": user_id}
# Enum constraint
from enum import Enum
class Color(str, Enum):
red = "red"
blue = "blue"
Códigos de Status e Tags
from fastapi import status
@app.post("/items", status_code=status.HTTP_201_CREATED,
tags=["items"])
async def create_item(item: Item):
return item
Corpo da Requisição
Modelos Pydantic
from pydantic import BaseModel, Field
class Item(BaseModel):
name: str
price: float = Field(gt=0, description="Must be positive")
tags: list[str] = []
Modelos Aninhados
class Address(BaseModel):
street: str
city: str
zip_code: str
class User(BaseModel):
name: str
address: Address
Usar em Endpoint
@app.post("/items")
async def create_item(item: Item):
return {"name": item.name, "price": item.price}
Recursos de Validação
| Field(gt=0) | Maior que 0 |
| Field(min_length=1) | Comprimento mínimo de string |
| Field(max_length=100) | Comprimento máximo de string |
| Field(pattern='^[a-z]+$') | Correspondência de padrão regex |
| Field(default=None) | Opcional com padrão |
| EmailStr | Validação de email (pydantic[email]) |
Parâmetros de Query
Parâmetros de Query Básicos
@app.get("/items")
async def list_items(skip: int = 0, limit: int = 10):
return items[skip : skip + limit]
# GET /items?skip=0&limit=20
Validação de Query
from fastapi import Query
@app.get("/search")
async def search(
q: str = Query(min_length=3, max_length=50),
page: int = Query(default=1, ge=1),
):
return {"q": q, "page": page}
Opcional e Obrigatório
async def read_items(
q: str | None = None, # optional
name: str = ..., # required (Ellipsis)
tags: list[str] = Query(default=[]),
):
return {"q": q, "name": name}
Headers e Cookies
from fastapi import Header, Cookie
async def read(
user_agent: str | None = Header(default=None),
session_id: str | None = Cookie(default=None),
):
return {"ua": user_agent}
Modelos de Resposta
Modelo de Resposta
class ItemOut(BaseModel):
name: str
price: float
@app.get("/items/{id}", response_model=ItemOut)
async def get_item(id: int):
return items[id] # filters out extra fields
Múltiplos Tipos de Resposta
from fastapi.responses import JSONResponse, HTMLResponse
@app.get("/html", response_class=HTMLResponse)
async def get_html():
return "
Hello
"
Opções do Modelo de Resposta
| response_model | Modelo Pydantic para filtragem de saída |
| response_model_exclude_unset | Omitir campos não definidos explicitamente |
| response_model_include | Lista branca de campos específicos |
| response_model_exclude | Lista negra de campos específicos |
Respostas de Erro
from fastapi import HTTPException
@app.get("/items/{id}")
async def get_item(id: int):
if id not in items:
raise HTTPException(status_code=404, detail="Not found")
return items[id]
Dependências
Dependência de Função
from fastapi import Depends
async def get_db():
db = SessionLocal()
try:
yield db
finally:
db.close()
Usar em Endpoint
@app.get("/users")
async def list_users(db: Session = Depends(get_db)):
return db.query(User).all()
Dependências Baseadas em Classe
class Pagination:
def __init__(self, skip: int = 0, limit: int = 10):
self.skip = skip
self.limit = limit
@app.get("/items")
async def list_items(pg: Pagination = Depends()):
return items[pg.skip : pg.skip + pg.limit]
Escopos de Dependência
| Depends(func) | Dependência por endpoint |
| app = FastAPI(dependencies=[...]) | Dependência global para todas as rotas |
| APIRouter(dependencies=[...]) | Dependência de nível de router |
| yield | Setup/teardown (sessões DB, locks) |
Autenticação
OAuth2 Password Bearer
from fastapi.security import OAuth2PasswordBearer
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
@app.get("/users/me")
async def read_me(token: str = Depends(oauth2_scheme)):
user = decode_token(token)
return user
Fluxo de Token JWT
from jose import jwt
SECRET = "your-secret-key"
def create_token(data: dict):
return jwt.encode(data, SECRET, algorithm="HS256")
def decode_token(token: str):
return jwt.decode(token, SECRET, algorithms=["HS256"])
Endpoint de Token
from fastapi.security import OAuth2PasswordRequestForm
@app.post("/token")
async def login(form: OAuth2PasswordRequestForm = Depends()):
user = authenticate(form.username, form.password)
if not user:
raise HTTPException(status_code=401)
return {"access_token": create_token({"sub": user.id})}
Esquemas de Segurança
| OAuth2PasswordBearer | Token Bearer via login por formulário |
| HTTPBasic | Auth básica usuário/senha |
| APIKeyHeader | Chave API no header |
| APIKeyCookie | Chave API no cookie |
Tarefas em Segundo Plano
Tarefa Simples em Segundo Plano
from fastapi import BackgroundTasks
def send_email(to: str, body: str):
# slow operation runs after response
email_client.send(to, body)
@app.post("/notify")
async def notify(bg: BackgroundTasks):
bg.add_task(send_email, "
[email protected]", "Hello!")
return {"status": "queued"}
Dependência com Segundo Plano
async def log_request(bg: BackgroundTasks):
bg.add_task(write_log, "request received")
@app.get("/items", dependencies=[Depends(log_request)])
async def list_items():
return items
Segundo Plano vs Workers
| BackgroundTasks | Tarefas leves após resposta (emails, logs) |
| Celery / ARQ | Tarefas pesadas que precisam de workers separados |
| asyncio.create_task | Corrotinas async disparadas e esquecidas |
Middleware
Middleware Personalizado
import time
from starlette.middleware.base import BaseHTTPMiddleware
class TimingMiddleware(BaseHTTPMiddleware):
async def dispatch(self, request, call_next):
start = time.time()
response = await call_next(request)
duration = time.time() - start
response.headers["X-Process-Time"] = str(duration)
return response
Adicionar Middleware
app.add_middleware(TimingMiddleware)
CORS
from fastapi.middleware.cors import CORSMiddleware
app.add_middleware(
CORSMiddleware,
allow_origins=["https://example.com"],
allow_methods=["*"],
allow_headers=["*"],
)
Middleware Embutido
| CORSMiddleware | Compartilhamento de recursos de origem cruzada |
| TrustedHostMiddleware | Restringir hostnames permitidos |
| GZipMiddleware | Compressão gzip de respostas |
| HTTPSRedirectMiddleware | Redirecionar HTTP para HTTPS |
Testes
Cliente de Teste
from fastapi.testclient import TestClient
client = TestClient(app)
def test_read_root():
resp = client.get("/")
assert resp.status_code == 200
assert resp.json() == {"message": "Hello, World!"}
Testar POST
def test_create_item():
resp = client.post("/items", json={
"name": "Widget",
"price": 9.99,
})
assert resp.status_code == 201
assert resp.json()["name"] == "Widget"
Substituir Dependências
async def mock_db():
return FakeDB()
app.dependency_overrides[get_db] = mock_db
def test_with_mock_db():
resp = client.get("/users")
assert resp.status_code == 200
Testes Assíncronos
import pytest
from httpx import AsyncClient, ASGITransport
@pytest.mark.anyio
async def test_async():
transport = ASGITransport(app=app)
async with AsyncClient(transport=transport) as ac:
resp = await ac.get("/")
assert resp.status_code == 200