Skip to content

AsyncAPIProto

faststream.asyncapi.proto.AsyncAPIProto #

Bases: Protocol

A class representing an asynchronous API operation.

title_ instance-attribute #

title_

AsyncAPI object title.

description_ instance-attribute #

description_

AsyncAPI object description.

include_in_schema instance-attribute #

include_in_schema

Whetever to include operation in AsyncAPI schema or not.

name abstractmethod property #

name

Returns the name of the API operation.

description abstractmethod property #

description

Returns the description of the API operation.

schema abstractmethod #

schema()

Generate AsyncAPI schema.

Source code in faststream/asyncapi/proto.py
@abstractmethod
def schema(self) -> Dict[str, "Channel"]:
    """Generate AsyncAPI schema."""
    ...