Skip to main content

@nest-native/asyncapi

Decorator-first AsyncAPI 3.0 documentation for NestJS event-driven services — the AsyncAPI counterpart to @nestjs/swagger

3.0

AsyncAPI 3.0 Native

Built around the channels, operations, and messages model that AsyncAPI 3.0 introduced — not a 2.x port. Every generated document is validated against the official @asyncapi/parser.

DX

Swagger Mental Model

Decorate handlers and DTOs, then generate on boot. The same flow any Nest user already knows from documenting an HTTP API with @nestjs/swagger, applied to the event side.

API

Five Decorators

@AsyncApiChannel, @AsyncApiPub / @AsyncApiSub, @AsyncApiMessage, and @AsyncApiHeaders map directly onto AsyncAPI primitives. @AsyncApiServer declares the brokers you connect to.

Bus

Transport Bindings

Typed Kafka, NATS, MQTT, and AMQP bindings for servers, channels, operations, and messages, emitted verbatim onto the spec so transport identity stays explicit.

Web

Docs Route With Viewer

AsyncApiModule.setup serves the viewer page plus raw JSON and YAML on your existing HTTP server. Adapter-agnostic across Express and Fastify.

Zero

Zero Runtime Dependencies

The published package keeps runtime dependencies empty. Nest, the AsyncAPI parser, the viewer, and validation libraries stay under the host application's control as optional peers.