websocket_endpoint() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ websocket_endpoint() — fastapi Function Reference

Dependency Diagram

graph TD
  4b869ee9_812b_8d35_163b_2975ded25369["websocket_endpoint()"]
  f565d9f5_3e56_319e_ccb9_cd9f01a5b196["tutorial002_py39.py"]
  4b869ee9_812b_8d35_163b_2975ded25369 -->|defined in| f565d9f5_3e56_319e_ccb9_cd9f01a5b196
  style 4b869ee9_812b_8d35_163b_2975ded25369 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/websockets/tutorial002_py39.py lines 77–91

async def websocket_endpoint(
    websocket: WebSocket,
    item_id: str,
    q: Union[int, None] = None,
    cookie_or_token: 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}")