websocket_route() — fastapi Function Reference

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

Function python FastAPI Applications calls 1

Entity Profile

FastAPI→ Applications→ websocket_route() — fastapi Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

fastapi/applications.py lines 4543–4550

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

        return decorator