Gostaria de deixar minha contibuição ao que acrescentei ao meu projeto
https://www.youtube.com/watch?v=fshX_252HbU
muito simples !
Instalação @nestjs/swagger swagger-ui-express npm install --save @nestjs/swagger swagger-ui-express Também é possível usar o Swagger no Nest com o Fastify, basta usar a lib do swagger fastify-swagger
Configuração Abra o arquivo main.ts e adicione o seguinte conteúdo:
src/main.ts
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);
const config = new DocumentBuilder() .setTitle('Documentação com Swagger - Fábrica de Sinapse') .setDescription( 'O Swagger (aka OpenApi) é uma biblioteca muito conhecida no universo backend, estando disponível para diversas linguagens e frameworks. Ela gera um site interno no seu backend que descreve, com muitos detalhes, cada endpoint e estrutura de entidades presentes na sua aplicação.', ) .setVersion('1.0') .addTag('users') .build();
const document = SwaggerModule.createDocument(app, config); SwaggerModule.setup('api', app, document);
await app.listen(3000); }
bootstrap(); Acessando Execute a aplicação
npm run start:dev Abra a URL no seu navegador
Pronto!
Fonte : https://github.com/FabricaDeSinapse/nestjs-documentacao-swagger