Class OpenapiViewerRouter

A router class for serving OpenAPI documentation via Express. Handles both UI presentation and raw spec file serving in JSON/YAML formats.

Example

const config = {
  filePathOrSpec: './openapi.yml',
  uiPath: '/api-docs',
  rawPath: '/spec'
};
const router = new OpenapiViewerRouter(config);
router.setup();
app.use('/', router.getRouter());

Remarks

The router must be setup using the setup method before it can be used. The setup method can only be called once per instance.

Constructors

constructor

Methods

getRouter setup

Constructors

constructor

Methods

getRouter

  • getRouter(): Router

    Retrieves the configured Express router instance.

    Returns Router

    The configured Express router

    Throws

    When called before running setup

setup

  • setup(): void

    Initializes the OpenAPI router with the specified configuration. Sets up routes for serving the OpenAPI specification in JSON and YAML formats, as well as configuring the Swagger UI endpoint.

    Returns void

    Throws

    If setup is called more than once on the same instance

    The method performs the following:

    1. Loads the OpenAPI specification from file if path is provided, or uses the provided spec object
    2. Creates routes for serving the raw specification in different formats (.json, .yml, .yaml)
    3. Sets up the Swagger UI endpoint

Settings

Member Visibility

On This Page

Constructors
Methods