websocket_endpoint() — fastapi Function Reference

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

Function python FastAPI Routing

Entity Profile

FastAPI→ Routing→ websocket_endpoint() — fastapi Function Reference

Dependency Diagram

graph TD
  3bc173a3_aebe_16ed_a0c3_7afd880f9402["websocket_endpoint()"]
  891d4554_fd2c_26f0_e3bd_6bfe635f8c6e["tutorial002_an_py39.py"]
  3bc173a3_aebe_16ed_a0c3_7afd880f9402 -->|defined in| 891d4554_fd2c_26f0_e3bd_6bfe635f8c6e
  style 3bc173a3_aebe_16ed_a0c3_7afd880f9402 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

docs_src/websockets/tutorial002_an_py39.py lines 77–92

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