ag2ai · Lancetnik · May 22, 2025 · Mar 12, 2025 · Mar 18, 2025 · Mar 19, 2025
diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -242,6 +242,8 @@ search:
                     - [make_asyncapi_asgi](api/faststream/asgi/factories/make_asyncapi_asgi.md)
                     - [make_ping_asgi](api/faststream/asgi/factories/make_ping_asgi.md)
                 - handlers
+                    - [GetHandler](api/faststream/asgi/handlers/GetHandler.md)
+                    - [HttpHandler](api/faststream/asgi/handlers/HttpHandler.md)
                     - [get](api/faststream/asgi/handlers/get.md)
                 - response
                     - [AsgiResponse](api/faststream/asgi/response/AsgiResponse.md)
@@ -254,6 +256,7 @@ search:
                     - [AsyncAPIOperation](api/faststream/asyncapi/abc/AsyncAPIOperation.md)
                 - generate
                     - [get_app_schema](api/faststream/asyncapi/generate/get_app_schema.md)
+                    - [get_asgi_routes](api/faststream/asyncapi/generate/get_asgi_routes.md)
                     - [get_broker_channels](api/faststream/asyncapi/generate/get_broker_channels.md)
                     - [get_broker_server](api/faststream/asyncapi/generate/get_broker_server.md)
                 - message

diff --git a/docs/docs/en/api/faststream/asgi/handlers/GetHandler.md b/docs/docs/en/api/faststream/asgi/handlers/GetHandler.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.handlers.GetHandler
diff --git a/docs/docs/en/api/faststream/asgi/handlers/HttpHandler.md b/docs/docs/en/api/faststream/asgi/handlers/HttpHandler.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.handlers.HttpHandler
diff --git a/docs/docs/en/api/faststream/asyncapi/generate/get_asgi_routes.md b/docs/docs/en/api/faststream/asyncapi/generate/get_asgi_routes.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asyncapi.generate.get_asgi_routes
diff --git a/docs/docs/en/getting-started/asgi.md b/docs/docs/en/getting-started/asgi.md
@@ -103,6 +103,31 @@ app = AsgiFastStream(
     You do not need to setup all routes using the `asgi_routes=[]` parameter.<br/>
     You can use the `#!python app.mount("/health", asgi_endpoint)` method also.
 
+### ASGI Documentation
+By default, any ASGI routes will be added to your AsyncAPI documentation. If you wish to exclude these routes, just do the following:
+
+```
+app = AsgiFastStream(
+    broker,
+    asgi_routes=[
+        ("/health", make_ping_asgi(broker, timeout=5.0, include_in_schema=False)),
+    ]
+)
+```
+
+Or, for custom ASGI routes:
+
+```
+@get(include_in_schema=False)
+async def liveness_ping(scope):
+    return AsgiResponse(b"", status_code=200)
+
+app = AsgiFastStream(
+    broker,
+    asgi_routes=[("/health", liveness_ping)]
+)
+```
+
 ### AsyncAPI Documentation
 
 You can also host your **AsyncAPI** documentation in the same process, by running [`#!shell faststream docs serve ...`](./asyncapi/hosting.md){.internal-link}, in the same container and runtime.
@@ -158,7 +183,7 @@ app = FastStream(broker).as_asgi(
 
 ## Other ASGI Compatibility
 
-Moreover, our wrappers can be used as ready-to-use endpoins for other **ASGI** frameworks. This can be very helpful When you are running **FastStream** in the same runtime as any other **ASGI** frameworks.
+Moreover, our wrappers can be used as ready-to-use endpoints for other **ASGI** frameworks. This can be very helpful When you are running **FastStream** in the same runtime as any other **ASGI** frameworks.
 
 Just follow the following example in such cases:
 

diff --git a/faststream/asgi/factories.py b/faststream/asgi/factories.py
@@ -23,16 +23,16 @@ def make_ping_asgi(
     broker: "BrokerUsecase[Any, Any]",
     /,
     timeout: Optional[float] = None,
+    include_in_schema: bool = True,
 ) -> "ASGIApp":
     healthy_response = AsgiResponse(b"", 204)
     unhealthy_response = AsgiResponse(b"", 500)
 
-    @get
+    @get(include_in_schema=include_in_schema)
     async def ping(scope: "Scope") -> AsgiResponse:
         if await broker.ping(timeout):
             return healthy_response
-        else:
-            return unhealthy_response
+        return unhealthy_response
 
     return ping
 
@@ -50,10 +50,11 @@ def make_asyncapi_asgi(
     title: str = "FastStream",
     asyncapi_js_url: str = ASYNCAPI_JS_DEFAULT_URL,
     asyncapi_css_url: str = ASYNCAPI_CSS_DEFAULT_URL,
+    include_in_schema: bool = True,
 ) -> "ASGIApp":
     cached_docs = None
 
-    @get
+    @get(include_in_schema=include_in_schema)
     async def docs(scope: "Scope") -> AsgiResponse:
         nonlocal cached_docs
         if not cached_docs:

diff --git a/faststream/asgi/handlers.py b/faststream/asgi/handlers.py
@@ -1,40 +1,88 @@
-from functools import wraps
-from typing import (
-    TYPE_CHECKING,
-    Sequence,
-)
+from typing import TYPE_CHECKING, Callable, Optional, Sequence, Union, overload
 
 from faststream.asgi.response import AsgiResponse
 
 if TYPE_CHECKING:
     from faststream.asgi.types import ASGIApp, Receive, Scope, Send, UserApp
 
 
-def get(func: "UserApp") -> "ASGIApp":
-    methods = ("GET", "HEAD")
+class HttpHandler:
+    def __init__(
+        self,
+        func: "UserApp",
+        *,
+        include_in_schema: bool = True,
+        description: Optional[str] = None,
+        methods: Optional[Sequence[str]] = None,
+    ):
+        self.func = func
+        self.methods = methods or ()
+        self.include_in_schema = include_in_schema
+        self.description = description or func.__doc__
 
-    method_now_allowed_response = _get_method_not_allowed_response(methods)
-    error_response = AsgiResponse(body=b"Internal Server Error", status_code=500)
-
-    @wraps(func)
-    async def asgi_wrapper(
-        scope: "Scope",
-        receive: "Receive",
-        send: "Send",
-    ) -> None:
-        if scope["method"] not in methods:
-            response: ASGIApp = method_now_allowed_response
+    async def __call__(self, scope: "Scope", receive: "Receive", send: "Send") -> None:
+        if scope["method"] not in self.methods:
+            response: ASGIApp = _get_method_not_allowed_response(self.methods)
 
         else:
             try:
-                response = await func(scope)
+                response = await self.func(scope)
             except Exception:
-                response = error_response
+                response = AsgiResponse(body=b"Internal Server Error", status_code=500)
 
         await response(scope, receive, send)
         return
 
-    return asgi_wrapper
+
+class GetHandler(HttpHandler):
+    def __init__(
+        self,
+        func: "UserApp",
+        *,
+        include_in_schema: bool = True,
+        description: Optional[str] = None,
+    ):
+        super().__init__(
+            func,
+            include_in_schema=include_in_schema,
+            description=description,
+            methods=("GET", "HEAD"),
+        )
+
+
+@overload
+def get(
+    func: "UserApp",
+    *,
+    include_in_schema: bool = True,
+    description: Optional[str] = None,
+) -> "ASGIApp": ...
+
+
+@overload
+def get(
+    func: None = None,
+    *,
+    include_in_schema: bool = True,
+    description: Optional[str] = None,
+) -> Callable[["UserApp"], "ASGIApp"]: ...
+
+
+def get(
+    func: Optional["UserApp"] = None,
+    *,
+    include_in_schema: bool = True,
+    description: Optional[str] = None,
+) -> Union[Callable[["UserApp"], "ASGIApp"], "ASGIApp"]:
+    def decorator(inner_func: "UserApp") -> "ASGIApp":
+        return GetHandler(
+            inner_func, include_in_schema=include_in_schema, description=description
+        )
+
+    if func is None:
+        return decorator
+
+    return decorator(func)
 
 
 def _get_method_not_allowed_response(methods: Sequence[str]) -> AsgiResponse:

diff --git a/faststream/asyncapi/generate.py b/faststream/asyncapi/generate.py
@@ -28,6 +28,9 @@ def get_app_schema(app: "AsyncAPIApplication") -> Schema:
     servers = get_broker_server(broker)
     channels = get_broker_channels(broker)
 
+    # TODO: generate HTTP channels
+    # asgi_routes = get_asgi_routes(app)
+
     messages: Dict[str, Message] = {}
     payloads: Dict[str, Dict[str, Any]] = {}
     for channel_name, ch in channels.items():
@@ -54,6 +57,7 @@ def get_app_schema(app: "AsyncAPIApplication") -> Schema:
                     payloads,
                     messages,
                 )
+
     schema = Schema(
         info=Info(
             title=app.title,
@@ -136,6 +140,29 @@ def get_broker_channels(
     return channels
 
 
+def get_asgi_routes(
+    app: "AsyncAPIApplication",
+) -> Any:
+    """Get the ASGI routes for an application."""
+    # We should import this here due
+    # ASGI > Application > asynciapi.proto
+    # so it looks like a circular import
+    from faststream.asgi import AsgiFastStream
+    from faststream.asgi.handlers import HttpHandler
+
+    if not isinstance(app, AsgiFastStream):
+        return None
+
+    for route in app.routes:
+        path, asgi_app = route
+
+        if isinstance(asgi_app, HttpHandler) and asgi_app.include_in_schema:
+            # TODO: generate HTTP channel for handler
+            pass
+
+    return
+
+
 def _resolve_msg_payloads(
     m: Message,
     channel_name: str,

diff --git a/faststream/asyncapi/schema/main.py b/faststream/asyncapi/schema/main.py
@@ -83,7 +83,6 @@ class Schema(BaseModel):
         to_jsonable() -> Any: Convert the schema to a JSON-serializable object.
         to_json() -> str: Convert the schema to a JSON string.
         to_yaml() -> str: Convert the schema to a YAML string.
-
     """
 
     asyncapi: str = ASYNC_API_VERSION

diff --git a/tests/asyncapi/base/fastapi.py b/tests/asyncapi/base/fastapi.py
@@ -34,6 +34,7 @@ async def test_fastapi_full_information(self):
             contact={"name": "support", "url": "https://support.com"},
             license_info={"name": "some", "url": "https://some.com"},
         )
+
         app.include_router(broker)
 
         async with self.broker_wrapper(broker.broker):