Skip to content

get_asyncapi_html

faststream.specification.get_asyncapi_html #

get_asyncapi_html(
    schema: Specification,
    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 = "asyncapi/try",
) -> str

Generate HTML for displaying an AsyncAPI document.

Source code in faststream/specification/asyncapi/site.py 
 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
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def get_asyncapi_html(
    schema: "Specification",
    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 = "asyncapi/try",
) -> str:
    """Generate HTML for displaying an AsyncAPI document."""
    config = {
        "show": {
            "sidebar": sidebar,
            "info": info,
            "servers": servers,
            "operations": operations,
            "messages": messages,
            "schemas": schemas,
            "errors": errors,
        },
        "expand": {
            "messageExamples": expand_message_examples,
        },
        "sidebar": {
            "showServers": "byDefault",
            "showOperations": "byDefault",
        },
    }

    if try_it_out:
        plugins_js = f"""
        <script src="{asyncapi_js_url}"></script>
        <script src="{try_it_out_plugin_url}"></script>
        <script>
            const schema = {schema.to_json()};
            const config = {json_dumps(config).decode()};
            const endpoint = {try_it_out_url!r};
            const plugin = window.AsyncApiTryItPlugin.createTryItOutPlugin({{
                endpointBase: endpoint.replace(/^\\//, ""),
                resolveEndpoint: () => endpoint,
                showPayloadSchema: true,
                showEndpointInput: false,
                showRealBrokerToggle: true
            }});

            window.AsyncApiStandalone.render(
                {{
                    schema,
                    config,
                    plugins: [plugin]
                }},
                document.getElementById("asyncapi")
            );
        </script>"""

    else:
        standalone_config = {"schema": schema.to_json(), "config": config}
        plugins_js = f"""
        <script src="{asyncapi_js_url}"></script>
        <script>
            window.AsyncApiStandalone.render(
                {json_dumps(standalone_config).decode()},
                document.getElementById("asyncapi")
            );
        </script>"""

    return f"""<!DOCTYPE html>
<html>
    <head>
        <title>{schema.title} AsyncAPI</title>
        <link rel="icon" href="https://www.asyncapi.com/favicon.ico">
        <link rel="icon" type="image/png" sizes="16x16" href="https://www.asyncapi.com/favicon-16x16.png">
        <link rel="icon" type="image/png" sizes="32x32" href="https://www.asyncapi.com/favicon-32x32.png">
        <link rel="icon" type="image/png" sizes="194x194" href="https://www.asyncapi.com/favicon-194x194.png">
        <link rel="stylesheet" href="{asyncapi_css_url}">
    </head>
    <style>
    html {{
        font-family: ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol,Noto Color Emoji;
        line-height: 1.5;
    }}
    </style>
    <body>
        <div id="asyncapi"></div>
        {plugins_js}
    </body>
</html>"""