Method include_router

faststream/_internal/fastapi/router.py:476–511

Includes a router in the API.

(  # type: ignore[override]
        self,
        router: Union["StreamRouter[MsgType]", "BrokerRouter[MsgType]"],
        *,
        prefix: str = "",
        tags: list[str | Enum] | None = None,
        dependencies: Sequence["params.Depends"] | None = None,
        default_response_class: type[Response] = Default(JSONResponse),
        responses: dict[int | str, dict[str, Any]] | None = None,
        callbacks: list["BaseRoute"] | None = None,
        deprecated: bool | None = None,
        include_in_schema: bool = True,
        generate_unique_id_function: Callable[["APIRoute"], str] = Default(
            generate_unique_id,
        ),
    )

        return docs_router

    def include_router(  # type: ignore[override]
        self,
        router: Union["StreamRouter[MsgType]", "BrokerRouter[MsgType]"],
        *,
        prefix: str = "",
        tags: list[str | Enum] | None = None,
        dependencies: Sequence["params.Depends"] | None = None,
        default_response_class: type[Response] = Default(JSONResponse),
        responses: dict[int | str, dict[str, Any]] | None = None,
        callbacks: list["BaseRoute"] | None = None,
        deprecated: bool | None = None,
        include_in_schema: bool = True,
        generate_unique_id_function: Callable[["APIRoute"], str] = Default(
            generate_unique_id,
        ),
    ) -> None:
        """Includes a router in the API."""
        if isinstance(router, BrokerRouter):
            for sub in router.subscribers:
                sub._call_decorators = (
                    self._subscriber_compatibility_wrapper(),
                    *sub._call_decorators,
                )

            self.broker.include_router(router)
            return

        msg = (
            "Including a StreamRouter into another StreamRouter is not supported "
            "and may cause subtle context issues (e.g. message dependencies "
            "returning EmptyPlaceholder). "
            "Use a regular broker router (e.g. KafkaRouter, RabbitRouter, etc.) "
            "for grouping subscribers and include that into the StreamRouter instead. "
            "See: https://faststream.ag2.ai/latest/getting-started/integrations/fastapi/#multiple-routers"
        )
        raise TypeError(msg)