Feature/106 documentacao swagger

backend/.env.test

@@ -0,0 +1,3 @@
+NODE_ENV=test
+DATABASE_HOST=mongodb://localhost:27017/
+DATABASE_NAME=dataviewer_test

backend/docker-compose.yml

@@ -0,0 +1,11 @@
+services:
+  mongo:
+    image: mongo:latest
+    container_name: mongo_container
+    ports:
+      - "27017:27017"
+    volumes:
+      - mongo_data:/data/db
+
+volumes:
+  mongo_data:

backend/nest-cli.json

@@ -1,5 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/nest-cli",
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
+  "sourceRoot": "src",
+  "plugins": [
+  {
+    "name": "@nestjs/swagger",
+    "options": {
+      "classValidatorShim": false,
+      "introspectComments": true
+    }
+  }
+]
 }

backend/package.json

@@ -30,10 +30,13 @@
     "@nestjs/mongoose": "^9.2.1",
     "@nestjs/passport": "^9.0.0",
     "@nestjs/platform-express": "^9.0.0",
+    "@nestjs/swagger": "^8.0.7",
     "bcrypt": "^5.1.0",
     "handlebars": "^4.7.7",
     "mongoose": "^6.7.2",
+    "multer": "^1.4.5-lts.1",
     "nodemailer": "^6.9.3",
+    "papaparse": "^5.4.1",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.0",
     "passport-local": "^1.0.0",
@@ -48,6 +51,7 @@
     "@types/bcrypt": "^5.0.0",
     "@types/express": "^4.17.13",
     "@types/jest": "28.1.8",
+    "@types/multer": "^1.4.11",
     "@types/node": "^16.0.0",
     "@types/nodemailer": "^6.4.8",
     "@types/passport-jwt": "^3.0.7",

backend/src/main.ts

@@ -1,9 +1,29 @@
 import { NestFactory } from '@nestjs/core';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+
   app.enableCors();
+
+  const config = new DocumentBuilder()
+    .setTitle('Docs')
+    .setDescription('Dataviewer API description')
+    .addBearerAuth(
+      {
+        type: 'http',
+        scheme: 'bearer',
+        name: 'Authorization',
+        description: 'Enter token',
+        in: 'header',
+      },
+      'KEY_AUTH',
+    )
+    .build();
+  const documentFactory = () => SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('swagger/docs', app, documentFactory);
+
   await app.listen(3333);
 }
 bootstrap();

backend/src/modules/auth/auth.controller.ts

@@ -2,12 +2,29 @@ import { Controller, Post, Request, UseGuards } from '@nestjs/common';
 import { RequestWithLocalUser } from 'src/types/requests';
 import { AuthService } from './auth.service';
 import { LocalAuthGuard } from './guards/local-auth.guard';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
 
 @Controller('auth')
 export class AuthController {
   constructor(private authService: AuthService) {}
 
-  @UseGuards(LocalAuthGuard)
+  @ApiOperation({
+    summary: 'Login',
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Login successfull',
+    schema: {
+      type: 'object',
+      properties: {
+        accessToken: { type: 'string' },
+      },
+    },
+  }) // Resposta esperada
+  @ApiResponse({
+    status: 400,
+    description: 'Bad Request - The input data is invalid.',
+  })
   @Post('login')
   async login(@Request() req: RequestWithLocalUser) {
     return this.authService.login(req.user);