Api References NestJS

SwaggerModule

class

  
class SwaggerModule {
  static createDocument(app: INestApplication, config: Omit<OpenAPIObject, "paths">, options: SwaggerDocumentOptions = {}): OpenAPIObject
  static setup(path: string, app: INestApplication, document: OpenAPIObject, options?: SwaggerCustomOptions)
}

Static methods

createDocument()


static createDocument(app: INestApplication, config: Omit<OpenAPIObject, "paths">, options: SwaggerDocumentOptions = {}): OpenAPIObject

Parameters

Option	Type	Description
`app`	`INestApplication`
`config`	`Omit`
`options`	`SwaggerDocumentOptions`	Optional. Default is `{}`.

Returns

OpenAPIObject

setup()


static setup(path: string, app: INestApplication, document: OpenAPIObject, options?: SwaggerCustomOptions)

Parameters

Option	Type	Description
`path`	`string`
`app`	`INestApplication`
`document`	`OpenAPIObject`
`options`	`SwaggerCustomOptions`	Optional. Default is `undefined`.

Static methods#

createDocument() #

Parameters

Returns

setup() #

Parameters

Static methods

createDocument()

setup()