Request Parameters

Functions for declaring where parameters come from.

Query

def Query(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    gt: float = None,
    ge: float = None,
    lt: float = None,
    le: float = None,
    min_length: int = None,
    max_length: int = None,
    pattern: str = None,
    examples: List[Any] = None,
    deprecated: bool = None,
    ...
) -> Any

Declares a query string parameter.

Example:

@app.get("/items")
def list_items(
    page: int = Query(1, ge=1),
    limit: int = Query(10, ge=1, le=100)
):
    return []

---

Body

def Body(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    examples: List[Any] = None,
    deprecated: bool = None,
    ...
) -> Any

Declares a request body parameter.

Example:

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float

@app.post("/items")
def create_item(item: Item = Body(...)):
    return item

---

Path

def Path(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    gt: float = None,
    ge: float = None,
    lt: float = None,
    le: float = None,
    min_length: int = None,
    max_length: int = None,
    pattern: str = None,
    examples: List[Any] = None,
    deprecated: bool = None,
    ...
) -> Any

Declares a path parameter. Usually implicit but can be made explicit.

Example:

@app.get("/items/<int:item_id>")
def get_item(item_id: int = Path(..., gt=0)):
    return {"id": item_id}

---

Header

def Header(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    ...
) -> Any

Declares an HTTP header parameter.

Example:

@app.get("/protected")
def get_protected(
    x_token: str = Header(...),
    x_user_id: int = Header(...)
):
    return {}

Headers with underscores are converted to hyphens in the HTTP request. x_token matches the X-Token header.

---

Cookie

def Cookie(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    ...
) -> Any

Declares a cookie parameter.

Example:

@app.get("/profile")
def get_profile(session_id: str = Cookie(...)):
    return {}

---

Form

def Form(
    default: Any = ...,
    *,
    alias: str = None,
    title: str = None,
    description: str = None,
    ...
) -> Any

Declares a form field parameter (for application/x-www-form-urlencoded or multipart/form-data).

Example:

@app.post("/login")
def login(username: str = Form(...), password: str = Form(...)):
    return {"username": username}