Skip to content

AsyncAPIRoute

faststream.asgi.factories.asyncapi.route.AsyncAPIRoute #

AsyncAPIRoute(
    path: str,
    description: str | None = None,
    tags: Sequence[Union[Tag, TagDict, dict[str, Any]]]
    | None = None,
    unique_id: str | None = None,
    include_in_schema: bool = False,
    *,
    sidebar: bool = True,
    info: bool = True,
    servers: bool = True,
    operations: bool = True,
    messages: bool = True,
    schemas: bool = True,
    errors: bool = True,
    expand_message_examples: bool = True,
    asyncapi_js_url: str = ASYNCAPI_JS_DEFAULT_URL,
    asyncapi_css_url: str = ASYNCAPI_CSS_DEFAULT_URL,
    try_it_out_plugin_url: str = ASYNCAPI_TRY_IT_PLUGIN_URL,
    try_it_out: bool = True,
    try_it_out_url: str | None = None,
)

Configuration for AsyncAPI documentation route with try-it-out support.

Source code in faststream/asgi/factories/asyncapi/route.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def __init__(
    self,
    path: str,
    description: str | None = None,
    tags: Sequence[Union["Tag", "TagDict", dict[str, Any]]] | None = None,
    unique_id: str | None = None,
    include_in_schema: bool = False,
    *,
    sidebar: bool = True,
    info: bool = True,
    servers: bool = True,
    operations: bool = True,
    messages: bool = True,
    schemas: bool = True,
    errors: bool = True,
    expand_message_examples: bool = True,
    asyncapi_js_url: str = ASYNCAPI_JS_DEFAULT_URL,
    asyncapi_css_url: str = ASYNCAPI_CSS_DEFAULT_URL,
    try_it_out_plugin_url: str = ASYNCAPI_TRY_IT_PLUGIN_URL,
    try_it_out: bool = True,
    try_it_out_url: str | None = None,
) -> None:
    self.path = path

    self.description = description
    self.tags = tags
    self.unique_id = unique_id
    self.include_in_schema = include_in_schema

    self.sidebar = sidebar
    self.info = info
    self.servers = servers
    self.operations = operations
    self.messages = messages
    self.schemas = schemas
    self.errors = errors
    self.expand_message_examples = expand_message_examples
    self.asyncapi_js_url = asyncapi_js_url
    self.asyncapi_css_url = asyncapi_css_url
    self.try_it_out_plugin_url = try_it_out_plugin_url
    self.try_it_out = try_it_out
    if not try_it_out_url:
        try_it_out_url = path.rstrip("/") + "/try"
    self.try_it_out_url = try_it_out_url

path instance-attribute #

path = path

description instance-attribute #

description = description

tags instance-attribute #

tags = tags

unique_id instance-attribute #

unique_id = unique_id

include_in_schema instance-attribute #

include_in_schema = include_in_schema

sidebar instance-attribute #

sidebar = sidebar

info instance-attribute #

info = info

servers instance-attribute #

servers = servers

operations instance-attribute #

operations = operations

messages instance-attribute #

messages = messages

schemas instance-attribute #

schemas = schemas

errors instance-attribute #

errors = errors

expand_message_examples instance-attribute #

expand_message_examples = expand_message_examples

asyncapi_js_url instance-attribute #

asyncapi_js_url = asyncapi_js_url

asyncapi_css_url instance-attribute #

asyncapi_css_url = asyncapi_css_url

try_it_out_plugin_url instance-attribute #

try_it_out_plugin_url = try_it_out_plugin_url

try_it_out instance-attribute #

try_it_out = try_it_out

try_it_out_url instance-attribute #

try_it_out_url = try_it_out_url

ensure_route classmethod #

ensure_route(
    path: Union[str, AsyncAPIRoute],
) -> AsyncAPIRoute
Source code in faststream/asgi/factories/asyncapi/route.py 
65
66
67
68
69
@classmethod
def ensure_route(cls, path: Union[str, "AsyncAPIRoute"]) -> "AsyncAPIRoute":
    if isinstance(path, AsyncAPIRoute):
        return path
    return AsyncAPIRoute(path)