Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

ApiUrlScheme

ApiUrlScheme: "http" | "https"

Possible value for an API url scheme.

InitControllersSwaggerOptionsValue

InitControllersSwaggerOptionsValue: InitControllersSwaggerOptions | false

A possible value for 'swagger' property of 'InitControllersSwaggerOptions' interface.

(false) indicates NOT to setup Swagger UI.

SwaggerDefinitionList

SwaggerDefinitionList: {}

List of Swagger definitions.

Type declaration

  • [key: string]: any

SwaggerPathDefinition

SwaggerPathDefinition: any

A swagger path definition.

SwaggerPathDefinitionUpdater

SwaggerPathDefinitionUpdater: (context: SwaggerPathDefinitionUpdaterContext) => any

Updates a Swagger path definition.

param

The context.

Type declaration

SwaggerSecurityDefintion

SwaggerSecurityDefintion: {}

A security defintion.

Type declaration

  • [name: string]: any[]

Variables

Const SWAGGER_INFO

SWAGGER_INFO: typeof SWAGGER_INFO = ...

Key for storing a SwaggerInfo document.

Functions

Swagger

getSwaggerPathDefinitionUpdater

setSwaggerPathDefinitionUpdater

setupSwaggerUI

Generated using TypeDoc