Интеграция Swagger в NestJS

Установка необходимых зависимостей

npm install @nestjs/swagger

Настройка файла main.ts

1. Импорт модулей В начало файла добавляем:

import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger'

2. Конфигурация спецификации Объект config определяет метаданные вашей документации. Его необходимо создать внутри функции bootstrap():

const config = new DocumentBuilder()
    .setTitle('Заголовок документации')
    .setDescription('Описание документации')
    .setVersion('Версия документации')
    .build() 

3. Инициализация модуля Создание функции-фабрики, которая собирает спецификацию API на основе декораторов в контроллерах.

const documentFactory = () => SwaggerModule.createDocument(app, config);
SwaggerModule.setup('docs', app, documentFactory);

Метод setup подключает интерактивную документацию по пути /docs, связывая ее с приложением NestJS и созданным документом.