Class: SwaggerUiService
Constructors
new SwaggerUiService()
new SwaggerUiService(
settings,documentBuilder):SwaggerUiService
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
settings | SwaggerUiSettingsInterface | swagger ui settings |
documentBuilder | DocumentBuilder | - |
Returns
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.service.ts:16 (opens in a new tab)
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
documentBuilder | readonly | DocumentBuilder | - |
settings | readonly | SwaggerUiSettingsInterface | swagger ui settings |
Methods
builder()
builder():
DocumentBuilder
Returns document builder instance.
Returns
DocumentBuilder
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.service.ts:26 (opens in a new tab)
setup()
setup(
app):void
Setup.
Parameters
| Parameter | Type | Description |
|---|---|---|
app | INestApplication | Nest application instance |
Returns
void
Defined in
packages/nestjs-swagger-ui/src/swagger-ui.service.ts:35 (opens in a new tab)