websocket_route() — fastapi Function Reference

Architecture documentation for the websocket_route() function in routing.py from the fastapi codebase.

Function python FastAPI Routing called by 1

Entity Profile

FastAPI→ Routing→ websocket_route() — fastapi Function Reference

Dependency Diagram

graph TD
  62e33f81_1889_a252_c9d6_5c79e5cc671e["websocket_route()"]
  ecadd3bc_0c58_b4e5_06d8_57da79199adc["APIRouter"]
  62e33f81_1889_a252_c9d6_5c79e5cc671e -->|defined in| ecadd3bc_0c58_b4e5_06d8_57da79199adc
  4f6b658b_2cc7_6ed4_d1b0_d6ddb446ed4e["websocket_route()"]
  4f6b658b_2cc7_6ed4_d1b0_d6ddb446ed4e -->|calls| 62e33f81_1889_a252_c9d6_5c79e5cc671e
  style 62e33f81_1889_a252_c9d6_5c79e5cc671e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/routing.py lines 1252–1259

    def websocket_route(
        self, path: str, name: Union[str, None] = None
    ) -> Callable[[DecoratedCallable], DecoratedCallable]:
        def decorator(func: DecoratedCallable) -> DecoratedCallable:
            self.add_websocket_route(path, func, name=name)
            return func

        return decorator