add_api_websocket_route (routing)

fastapi · dev-tools, websocket-routing, route-registration, dependency-merging, realtime

Adds a WebSocket route to the router with optional dependencies, merging them with existing router-level dependencies.

    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)

See the full source, get the GitHub permalink, and search 40K more like it.

Get a free API key