Skip to content

get_asyncapi_html

faststream.asyncapi.get_asyncapi_html #

get_asyncapi_html(
    schema: Schema,
    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,
    title: str = "FastStream",
) -> str

Generate HTML for displaying an AsyncAPI document.

PARAMETER DESCRIPTION
schema

The AsyncAPI schema object.

TYPE: Schema

sidebar

Whether to show the sidebar. Defaults to True.

TYPE: bool DEFAULT: True

info

Whether to show the info section. Defaults to True.

TYPE: bool DEFAULT: True

servers

Whether to show the servers section. Defaults to True.

TYPE: bool DEFAULT: True

operations

Whether to show the operations section. Defaults to True.

TYPE: bool DEFAULT: True

messages

Whether to show the messages section. Defaults to True.

TYPE: bool DEFAULT: True

schemas

Whether to show the schemas section. Defaults to True.

TYPE: bool DEFAULT: True

errors

Whether to show the errors section. Defaults to True.

TYPE: bool DEFAULT: True

expand_message_examples

Whether to expand message examples. Defaults to True.

TYPE: bool DEFAULT: True

title

The title of the HTML document. Defaults to "FastStream".

TYPE: str DEFAULT: 'FastStream'

RETURNS DESCRIPTION
str

The generated HTML document.

TYPE: str

RAISES DESCRIPTION
NotImplementedError

If silent animals are not supported.

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

Source code in faststream/asyncapi/site.py 
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 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
 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
def get_asyncapi_html(
    schema: "Schema",
    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,
    title: str = "FastStream",
) -> str:
    """Generate HTML for displaying an AsyncAPI document.

    Args:
        schema (Schema): The AsyncAPI schema object.
        sidebar (bool, optional): Whether to show the sidebar. Defaults to True.
        info (bool, optional): Whether to show the info section. Defaults to True.
        servers (bool, optional): Whether to show the servers section. Defaults to True.
        operations (bool, optional): Whether to show the operations section. Defaults to True.
        messages (bool, optional): Whether to show the messages section. Defaults to True.
        schemas (bool, optional): Whether to show the schemas section. Defaults to True.
        errors (bool, optional): Whether to show the errors section. Defaults to True.
        expand_message_examples (bool, optional): Whether to expand message examples. Defaults to True.
        title (str, optional): The title of the HTML document. Defaults to "FastStream".

    Returns:
        str: The generated HTML document.

    Raises:
        NotImplementedError: If silent animals are not supported.
    !!! note

        The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)
    """
    schema_json = schema.to_json()

    config = {
        "schema": schema_json,
        "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",
            },
        },
    }

    return (
        """
    <!DOCTYPE html>
    <html>
        <head>
    """
        f"""
        <title>{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="https://unpkg.com/@asyncapi/react-component@1.0.0-next.46/styles/default.min.css">
        </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>

        <script src="https://unpkg.com/@asyncapi/react-component@1.0.0-next.47/browser/standalone/index.js"></script>
        <script>
    """
        f"""
            AsyncApiStandalone.render({json.dumps(config)}, document.getElementById('asyncapi'));
    """
        """
        </script>
        </body>
    </html>
    """
    )
Last update: 2023-11-13