OpenAPI - Nestjs-query

Configure Swagger

Use the standard Nest Swagger setup: main.ts

import { ValidationPipe } from '@nestjs/common'
import { NestFactory } from '@nestjs/core'
import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
import { AppModule } from './app.module'

async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  app.useGlobalPipes(new ValidationPipe({ transform: true, whitelist: true }))
  const config = new DocumentBuilder().setTitle('Todo API').setVersion('1.0').addBearerAuth().build()
  const document = SwaggerModule.createDocument(app, config)
  SwaggerModule.setup('api', app, document)
  await app.listen(3000)
}
void bootstrap()

The Swagger UI is then available at /api.

Customize generated operations

Set shared tags at the endpoint level and operation-specific descriptions, tags, or Swagger operation options under one or many.

{
  DTOClass: TodoItemDTO,
  EntityClass: TodoItemEntity,
  tags: ['Todo items'],
  read: {
    many: {
      description: 'List todo items visible to the current user',
      operationOptions: {
        summary: 'List todo items',
        deprecated: false
      }
    }
  }
}

Operation IDs are derived from the plural DTO name, for example todoItemDTOs.queryMany and todoItemDTOs.createOne. Use dtoName to change that logical name and basePath to change only the URL path.

Schema accuracy

Use @Field, @FilterableField, and @IDField on DTO properties so Swagger, transformation, and validation share the same metadata. When reflection cannot infer a nested or array type, pass a return type explicitly:

@Field(() => [LabelDTO], { description: 'Labels attached to the task' })
labels!: LabelDTO[]

Edit this page

​Configure Swagger​

​Customize generated operations​

​Schema accuracy​

Configure Swagger

Customize generated operations

Schema accuracy