Docs Route

AsyncApiModule.setup() mirrors SwaggerModule.setup: given the document produced by getAsyncApiDocument() and a base route, it serves the AsyncAPI viewer page plus the raw JSON and YAML on the application's existing HTTP server.

import { NestFactory } from '@nestjs/core';
import { AsyncApiModule, getAsyncApiDocument } from '@nest-native/asyncapi';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  const document = getAsyncApiDocument(app, {
    title: 'Orders Service',
    version: '1.0.0',
  });

  AsyncApiModule.setup('async-docs', app, document, {
    title: 'Orders Service — AsyncAPI',
  });

  await app.listen(3000);
}

This mounts three GET routes:

Route	Default	Serves
Viewer page	/async-docs	HTML page rendering the AsyncAPI viewer
JSON spec	/async-docs-json	application/json document
YAML spec	/async-docs-yaml	application/yaml document

setup() returns the normalized routes it mounted: { uiUrl, jsonUrl, yamlUrl }.

Ordering

Call setup() before app.listen() (and before any explicit app.init()), the same ordering SwaggerModule.setup requires: the routes attach to the HTTP adapter before the server finalizes its routing table. The document is captured at setup time, mirroring the generate-on-boot model, so the served spec is stable for the process lifetime.

Calling setup() on an application with no initialized HTTP adapter — for example a pure microservice — throws an actionable error rather than failing later, because the docs routes need an HTTP server to attach to.

Adapter Support

The route handlers are adapter-agnostic. They probe for the response API the underlying framework exposes and fall back across alternatives, so the same call works on both @nestjs/platform-express and @nestjs/platform-fastify without importing either framework's types.

Options

AsyncApiDocsOptions extends the viewer options:

Option	Purpose
jsonDocumentUrl	Override the JSON route (default ${path}-json)
yamlDocumentUrl	Override the YAML route (default ${path}-yaml)
title	Title shown on the viewer page
viewer options	Presentation options forwarded to the HTML renderer

Routes are normalized to a single leading slash, so passing docs or /docs behaves identically.

Security

The docs route exposes your channels, operations, and message schemas. Treat it like any other internal surface:

• Guard it with the same auth and network boundaries you apply to internal tooling. A spec can leak schema details not meant for unauthenticated readers.
• Keep secrets and internal identifiers out of example payloads and @AsyncApiServer hosts so they never reach the rendered viewer.
• Treat @AsyncApiServer hosts as trusted configuration, not user input.

See Security for the full checklist. For a runnable example, see sample/04-docs-route.