NestJS · Junior · Question 56 of 75

How do you generate OpenAPI (Swagger) docs in Nest?

1Nest generates docs only in production
2Write the YAML file by hand; there's no integration
✓Correct answer: With @nestjs/swagger: build a document with DocumentBuilder and serve it with SwaggerModule.setup()

Explanation

Decorators like @ApiProperty() describe DTOs; the Swagger CLI plugin can infer many of them from TypeScript types.

Further reading

NestJS: OpenAPI (Swagger) ↗

Test yourself

Take the NestJS · Junior quiz: questions and options are shuffled, and you get a review of your mistakes at the end.