Litestar AsyncAPI¶

Generate AsyncAPI 3.1 documents from the WebSocket routes, Server-Sent Event routes and ChannelsPlugin topics of a Litestar application, or supply explicit channel contracts. Serve packaged documentation with optional WebSocket interaction, or export documents without mounting any docs routes.

The implementation reuses Litestar's schema creator, application encoders, routers, CLI, and JSON/YAML renderers. Inline schemas use Draft07 tuple semantics. AsyncAPI 3.0 remains an explicit configuration option.

Start with Installation, then consult the Learn guides and the runnable examples. Existing users should read the migration guide before upgrading. The documentation UI guide records Scalar display limitations and the optional console's advisory validation behavior.