typing - Code Search

docs_src/query_param_models/tutorial001_py310.py

from typing import Literal

from fastapi import FastAPI, Query
from pydantic import BaseModel, Field

app = FastAPI()


class FilterParams(BaseModel):
    limit: int = Field(100, gt=0, le=100)
    offset: int = Field(0, ge=0)
    order_by: Literal["created_at", "updated_at"] = "created_at"
    tags: list[str] = []


@app.get("/items/")
async def read_items(filter_query: FilterParams = Query()):

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Tue Sep 17 18:54:10 UTC 2024

- 422 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/separate_openapi_schemas/tutorial002_py39.py

from typing import Optional

from fastapi import FastAPI
from pydantic import BaseModel


class Item(BaseModel):
    name: str
    description: Optional[str] = None


app = FastAPI(separate_input_output_schemas=False)


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


@app.get("/items/")
def read_items() -> list[Item]:
    return [
        Item(
            name="Portal Gun",

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Fri Aug 25 19:10:22 UTC 2023

- 518 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/pydantic_v1_in_v2/tutorial003_an_py39.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel as BaseModelV2
from pydantic.v1 import BaseModel


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    size: float


class ItemV2(BaseModelV2):
    name: str
    description: Union[str, None] = None
    size: float


app = FastAPI()


@app.post("/items/", response_model=ItemV2)

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 445 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/query_param_models/tutorial002_an_py39.py

from typing import Annotated, Literal

from fastapi import FastAPI, Query
from pydantic import BaseModel, Field

app = FastAPI()


class FilterParams(BaseModel):
    model_config = {"extra": "forbid"}

    limit: int = Field(100, gt=0, le=100)
    offset: int = Field(0, ge=0)
    order_by: Literal["created_at", "updated_at"] = "created_at"
    tags: list[str] = []


@app.get("/items/")

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 483 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_callable_endpoint.py

from functools import partial
from typing import Optional

from fastapi import FastAPI
from fastapi.testclient import TestClient


def main(some_arg, q: Optional[str] = None):
    return {"some_arg": some_arg, "q": q}


endpoint = partial(main, "foo")

app = FastAPI()

app.get("/")(endpoint)


client = TestClient(app)


def test_partial():
    response = client.get("/?q=bar")
    data = response.json()

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sun Jun 28 18:13:30 UTC 2020

- 457 bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/security/open_id_connect_url.py

from typing import Annotated, Optional

from annotated_doc import Doc
from fastapi.openapi.models import OpenIdConnect as OpenIdConnectModel
from fastapi.security.base import SecurityBase
from starlette.exceptions import HTTPException
from starlette.requests import Request
from starlette.status import HTTP_401_UNAUTHORIZED


class OpenIdConnect(SecurityBase):
    """
    OpenID Connect authentication class. An instance of it would be used as a

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 21:25:59 UTC 2025

- 3.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_forms_single_model.py

from typing import Annotated, Optional

from fastapi import FastAPI, Form
from fastapi.testclient import TestClient
from pydantic import BaseModel, Field

app = FastAPI()


class FormModel(BaseModel):
    username: str
    lastname: str
    age: Optional[int] = None
    tags: list[str] = ["foo", "bar"]
    alias_with: str = Field(alias="with", default="nothing")


class FormModelExtraAllow(BaseModel):
    param: str

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Dec 27 18:19:10 UTC 2025

- 3.4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_py39.py

from typing import Union

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/body_multiple_params/tutorial002_py39.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


class User(BaseModel):
    username: str
    full_name: Union[str, None] = None


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item, user: User):

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 490 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/path_params_numeric_validations/tutorial006_an_py39.py

from typing import Annotated

from fastapi import FastAPI, Path, Query

app = FastAPI()


@app.get("/items/{item_id}")
async def read_items(
    *,
    item_id: Annotated[int, Path(title="The ID of the item to get", ge=0, le=1000)],
    q: str,
    size: Annotated[float, Query(gt=0, lt=10.5)],
):
    results = {"item_id": item_id}
    if q:
        results.update({"q": q})
    if size:
        results.update({"size": size})

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Aug 28 23:39:15 UTC 2024

- 447 bytes

- Viewed (0)

Search Options