Function setup

setup(
    swaggerDoc?: JsonObject,
    opts?: SwaggerUiOptions,
    options?: SwaggerOptions,
    customCss?: string,
    customfavIcon?: string,
    swaggerUrl?: string,
    customSiteTitle?: string,
): RequestHandler
Creates a middleware function that returns the pre-generated HTML file for the Swagger UI page.
Parameters
- OptionalswaggerDoc: JsonObject
  JSON object with the API schema.
- Optionalopts: SwaggerUiOptions
  swagger-ui-express options.
- Optionaloptions: SwaggerOptions
  custom Swagger options.
- OptionalcustomCss: string
  string with a custom CSS to embed into the page.
- OptionalcustomfavIcon: string
  link to a custom favicon.
- OptionalswaggerUrl: string
  URL of the Swagger API schema, can be specified instead of the swaggerDoc.
- OptionalcustomSiteTitle: string
  custom title for a page.
Returns RequestHandler
an express middleware function that returns the generated HTML page.
- Defined in node_modules/@types/swagger-ui-express/index.d.ts:37
setup(swaggerDoc?: JsonObject, isExplorer?: boolean): RequestHandler
Parameters
- OptionalswaggerDoc: JsonObject
- OptionalisExplorer: boolean
Returns RequestHandler
Deprecated
- Defined in node_modules/@types/swagger-ui-express/index.d.ts:48