feat: add req body validation & swagger docs to users routes

Author: ocsoares

package-lock.json

@@ -34,6 +34,8 @@
     "@nestjs/swagger": "^7.3.1",
     "@prisma/client": "^5.13.0",
     "bcrypt": "^5.1.1",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
     "date-fns": "^3.6.0",
     "passport-jwt": "^4.0.1",
     "reflect-metadata": "^0.2.0",

package.json

@@ -0,0 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateUserDTO {
+  @ApiProperty({ type: 'string', example: 'John' })
+  @IsNotEmpty()
+  @IsString()
+  readonly name = '';
+
+  @ApiProperty({ type: 'string', example: 'Doe' })
+  @IsNotEmpty()
+  @IsString()
+  readonly lastName = '';
+
+  @ApiProperty({ type: 'string', example: '(55) 99671-6164' })
+  @IsNotEmpty()
+  @IsString()
+  readonly phone = '';
+}

src/users/dtos/CreateUserDTO.ts

@@ -0,0 +1,29 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional, IsString } from 'class-validator';
+
+export class UpdateUserDTO {
+  @ApiProperty({ type: 'string', example: 'John' })
+  @IsOptional()
+  @IsString()
+  readonly name?: string;
+
+  @ApiProperty({ type: 'string', example: 'Doe' })
+  @IsOptional()
+  @IsString()
+  readonly lastName?: string;
+
+  @ApiProperty({ type: 'string', example: 'John' })
+  @IsOptional()
+  @IsString()
+  readonly login?: string;
+
+  @ApiProperty({ type: 'string', example: 'john123' })
+  @IsOptional()
+  @IsString()
+  readonly password?: string;
+
+  @ApiProperty({ type: 'string', example: '(55) 99671-6164' })
+  @IsOptional()
+  @IsString()
+  readonly phone?: string;
+}

src/users/dtos/UpdateUserDTO.ts

@@ -9,12 +9,21 @@ import {
   Req,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiBearerAuth,
+  ApiCreatedResponse,
+  ApiInternalServerErrorResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
 
 import { UserGuard } from '@/guards/user.guard';
 import { ServerResponse } from '../utils';
 import { UsersService } from './users.service';
 import { AdminGuard } from '@/guards/admin.guard';
+import { CreateUserDTO } from './dtos/CreateUserDTO';
+import { UpdateUserDTO } from './dtos/UpdateUserDTO';
 
 @ApiTags('Usuários')
 @Controller('users')
@@ -23,9 +32,13 @@ export class UsersController {
 
   constructor(private readonly userServices: UsersService) {}
 
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiCreatedResponse()
   @Post('')
   @UseGuards(AdminGuard)
-  async store(@Body() body) {
+  async store(@Body() body: CreateUserDTO) {
     try {
       await this.userServices.store(body);
       return new ServerResponse(201, 'Successfully created user');
@@ -35,9 +48,14 @@ export class UsersController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiCreatedResponse()
   @Put(':id')
   @UseGuards(AdminGuard)
-  async update(@Body() body, @Param('id') id: string) {
+  async update(@Body() body: UpdateUserDTO, @Param('id') id: string) {
     try {
       await this.userServices.update(id, body);
       return new ServerResponse(201, 'Successfully updated user');
@@ -47,9 +65,14 @@ export class UsersController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiInternalServerErrorResponse()
+  @ApiCreatedResponse()
   @Put('')
   @UseGuards(UserGuard)
-  async selfUpdate(@Body() body, @Req() req) {
+  async selfUpdate(@Body() body: UpdateUserDTO, @Req() req) {
     try {
       const { userId } = req.user;
       await this.userServices.update(userId, body);

src/users/types.ts

@@ -1,14 +1,14 @@
 import { Injectable } from '@nestjs/common';
 
 import { PrismaService } from '../prisma/prisma.service';
-import { CreateUserSchema, UpdateUserSchema } from './types';
+import { CreateUserDTO } from './dtos/CreateUserDTO';
+import { UpdateUserDTO } from './dtos/UpdateUserDTO';
 
 @Injectable()
 export class UsersService {
   constructor(private readonly prismaService: PrismaService) {}
 
-  async store(body: any) {
-    const { name, lastName, phone } = CreateUserSchema.parse(body);
+  async store({ name, lastName, phone }: CreateUserDTO) {
     await this.prismaService.user.create({
       data: {
         name,
@@ -21,14 +21,13 @@ export class UsersService {
     });
   }
 
-  async update(id: string, body: any) {
-    const payload = UpdateUserSchema.parse(body);
+  async update(id: string, body: UpdateUserDTO) {
     await this.prismaService.user.update({
       where: {
         id,
       },
       data: {
-        ...payload,
+        ...body,
         updatedAt: new Date().toISOString(),
       },
     });