add_api_websocket_route() — fastapi Function Reference

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

Function python FastAPI Routing called by 3

Entity Profile

FastAPI→ Routing→ add_api_websocket_route() — fastapi Function Reference

Dependency Diagram

graph TD
  50d27352_5915_310d_fe1d_f8784a990ec3["add_api_websocket_route()"]
  ecadd3bc_0c58_b4e5_06d8_57da79199adc["APIRouter"]
  50d27352_5915_310d_fe1d_f8784a990ec3 -->|defined in| ecadd3bc_0c58_b4e5_06d8_57da79199adc
  ba33b279_1103_0775_a008_211bf9ab87de["add_api_websocket_route()"]
  ba33b279_1103_0775_a008_211bf9ab87de -->|calls| 50d27352_5915_310d_fe1d_f8784a990ec3
  b52314f4_2210_73b7_9368_6287f2dc93a0["websocket()"]
  b52314f4_2210_73b7_9368_6287f2dc93a0 -->|calls| 50d27352_5915_310d_fe1d_f8784a990ec3
  c1d02f65_9a84_123a_bdd4_304e5732f35a["include_router()"]
  c1d02f65_9a84_123a_bdd4_304e5732f35a -->|calls| 50d27352_5915_310d_fe1d_f8784a990ec3
  style 50d27352_5915_310d_fe1d_f8784a990ec3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/routing.py lines 1164–1183

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

        route = APIWebSocketRoute(
            self.prefix + path,
            endpoint=endpoint,
            name=name,
            dependencies=current_dependencies,
            dependency_overrides_provider=self.dependency_overrides_provider,
        )
        self.routes.append(route)