add_api_websocket_route() — fastapi Function Reference

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

Function python FastAPI Applications calls 1 called by 1

Entity Profile

FastAPI→ Applications→ add_api_websocket_route() — fastapi Function Reference

Dependency Diagram

graph TD
  ba33b279_1103_0775_a008_211bf9ab87de["add_api_websocket_route()"]
  587454b3_6db6_011f_9fa4_3e4e2e09b72d["FastAPI"]
  ba33b279_1103_0775_a008_211bf9ab87de -->|defined in| 587454b3_6db6_011f_9fa4_3e4e2e09b72d
  7c16e84d_2ff5_4884_612a_8f36a61c9299["websocket()"]
  7c16e84d_2ff5_4884_612a_8f36a61c9299 -->|calls| ba33b279_1103_0775_a008_211bf9ab87de
  50d27352_5915_310d_fe1d_f8784a990ec3["add_api_websocket_route()"]
  ba33b279_1103_0775_a008_211bf9ab87de -->|calls| 50d27352_5915_310d_fe1d_f8784a990ec3
  style ba33b279_1103_0775_a008_211bf9ab87de fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/applications.py lines 1259–1272

    def add_api_websocket_route(
        self,
        path: str,
        endpoint: Callable[..., Any],
        name: Optional[str] = None,
        *,
        dependencies: Optional[Sequence[Depends]] = None,
    ) -> None:
        self.router.add_api_websocket_route(
            path,
            endpoint,
            name=name,
            dependencies=dependencies,
        )