Api References NestJS

SwaggerDocumentOptions

interface


interface SwaggerDocumentOptions {
  include?: Function[]
  extraModels?: Function[]
  ignoreGlobalPrefix?: boolean
  deepScanRoutes?: boolean
  operationIdFactory?: OperationIdFactory
  linkNameFactory?: (controllerKey: string, methodKey: string, fieldKey: string) => string
  autoTagControllers?: boolean
}

Properties

Property	Description
`include?: Function[]`	List of modules to include in the specification
`extraModels?: Function[]`	Additional, extra models that should be inspected and included in the specification
`ignoreGlobalPrefix?: boolean`	If `true`, swagger will ignore the global prefix set through `setGlobalPrefix()` method
`deepScanRoutes?: boolean`	If `true`, swagger will also load routes from the modules imported by `include` modules
`operationIdFactory?: OperationIdFactory`	Custom operationIdFactory that will be used to generate the `operationId` based on the `controllerKey`, `methodKey`, and version.
`linkNameFactory?: (controllerKey: string, methodKey: string, fieldKey: string) => string`	Custom linkNameFactory that will be used to generate the name of links in the `links` field of responses
`autoTagControllers?: boolean`