Skip to content

API reference

Every name on these pages is importable from litestar_asyncapi, litestar_asyncapi.spec or the module shown in its heading.

  • Plugin and configuration: AsyncAPIPlugin, AsyncAPIConfig and DocsConfig.
  • Contracts: the decorators, the channel, operation and message definitions, and the transport markers.
  • Generator and discovery: AsyncAPIGenerator and the WebSocket, Server-Sent Event and ChannelsPlugin extractors.
  • Schema generation: the per-document schema generator and the Draft07 export.
  • Renderers: the JSON, YAML and documentation UI render plugins.
  • Specification models: the AsyncAPI 3.0 and 3.1 objects that make up a document.
  • CLI: the litestar asyncapi export command.