interface SwaggerDocumentOptions {
include?: Function[]
extraModels?: Function[]
ignoreGlobalPrefix?: boolean
deepScanRoutes?: boolean
operationIdFactory?: (controllerKey: string, methodKey: string) => string
}
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?: (controllerKey: string, methodKey: string) => string
|
Custom operationIdFactory that will be used to generate the operationId
based on the controllerKey and methodKey
By default is () => controllerKey_methodKey
|
