Libraries
    Preparing search index...

    Options passed to generateAsyncApiSpec.

    When server is provided, subscriptions are derived from it automatically (unless explicitly overridden).

    interface AsyncApiOptions {
        info: AsyncApiInfo;
        pathPrefix?: string;
        server?: AsyncApiServer_ServerLike;
        servers?: Record<string, AsyncApiServerEntry>;
        subscriptions?: readonly SubscriptionRegistration[];
    }
    Index

    Properties

    API metadata (title, version, description).

    pathPrefix?: string

    Path prefix to strip from all channel addresses. Useful when the subscription endpoints are mounted under a prefix that differs from how the AsyncAPI doc should describe them.

    A ServerBuilder (or any object implementing getSubscriptionRegistrations()). When set, subscription registrations are automatically read from the server instance. Explicit subscriptions values take precedence.

    servers?: Record<string, AsyncApiServerEntry>

    Server entries to include in the spec's servers map. Keys are server IDs (e.g. 'production', 'staging').

    subscriptions?: readonly SubscriptionRegistration[]

    Subscription registrations to document. When omitted, registrations are read from the server option.