websocket_endpoint() — fastapi Function Reference

Architecture documentation for the websocket_endpoint() function in tutorial002_an_py310.py from the fastapi codebase.

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ websocket_endpoint() — fastapi Function Reference

Dependency Diagram

graph TD
  9b2d92e2_fdc4_944a_d7ce_6d39cf71444c["websocket_endpoint()"]
  ea4bc443_e136_dc78_e6f9_6929ab7c8f27["tutorial002_an_py310.py"]
  9b2d92e2_fdc4_944a_d7ce_6d39cf71444c -->|defined in| ea4bc443_e136_dc78_e6f9_6929ab7c8f27
  style 9b2d92e2_fdc4_944a_d7ce_6d39cf71444c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/websockets/tutorial002_an_py310.py lines 77–92

async def websocket_endpoint(
    *,
    websocket: WebSocket,
    item_id: str,
    q: int | None = None,
    cookie_or_token: Annotated[str, Depends(get_cookie_or_token)],
):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(
            f"Session cookie or query token value is: {cookie_or_token}"
        )
        if q is not None:
            await websocket.send_text(f"Query parameter q is: {q}")
        await websocket.send_text(f"Message text was: {data}, for item ID: {item_id}")