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: |
sidebar | Whether to show the sidebar. Defaults to True. TYPE: |
info | Whether to show the info section. Defaults to True. TYPE: |
servers | Whether to show the servers section. Defaults to True. TYPE: |
operations | Whether to show the operations section. Defaults to True. TYPE: |
messages | Whether to show the messages section. Defaults to True. TYPE: |
schemas | Whether to show the schemas section. Defaults to True. TYPE: |
errors | Whether to show the errors section. Defaults to True. TYPE: |
expand_message_examples | Whether to expand message examples. Defaults to True. TYPE: |
title | The title of the HTML document. Defaults to "FastStream". TYPE: |
RETURNS | DESCRIPTION |
---|---|
str | The generated HTML document. TYPE: |
RAISES | DESCRIPTION |
---|---|
NotImplementedError | If silent animals are not supported. |
Note
The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)