Installation

Requirements

• Node.js 20+
• TypeScript 5+
• NestJS 10+ or 11+

Install the Package

npm install nestjs-openapi --save-dev

pnpm add -D nestjs-openapi

yarn add -D nestjs-openapi

Peer Dependencies

The library requires @nestjs/common. If you use @nestjs/swagger decorators in your code, you already have it installed.

{
  "@nestjs/common": "^10.0.0 || ^11.0.0"
}

Next Steps

Continue to Quick Start to generate your first OpenAPI spec.