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

Author: ocsoares

src/supply/dtos/CreateSupplyDTO.ts

@@ -0,0 +1,14 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateSupplyDTO {
+  @ApiProperty({ type: 'string', example: 'ID da Categoria do Suprimento' })
+  @IsNotEmpty()
+  @IsString()
+  readonly supplyCategoryId = '';
+
+  @ApiProperty({ type: 'string', example: 'Nome do Suprimento' })
+  @IsNotEmpty()
+  @IsString()
+  readonly name = '';
+}

src/supply/dtos/UpdateSupplyDTO.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional, IsString } from 'class-validator';
+
+export class UpdateSupplyDTO {
+  @ApiProperty({
+    required: false,
+    type: 'string',
+    example: 'ID da Categoria do Suprimento',
+  })
+  @IsOptional()
+  @IsString()
+  readonly supplyCategoryId?: string;
+
+  @ApiProperty({
+    required: false,
+    type: 'string',
+    example: 'Nome do Suprimento',
+  })
+  @IsOptional()
+  @IsString()
+  readonly name?: string;
+}

src/supply/supply.controller.ts

@@ -8,18 +8,27 @@ import {
   Post,
   Put,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiTags,
+} from '@nestjs/swagger';
 
 import { ServerResponse } from '../utils';
 import { SupplyService } from './supply.service';
+import { CreateSupplyDTO } from './dtos/CreateSupplyDTO';
+import { UpdateSupplyDTO } from './dtos/UpdateSupplyDTO';
 
 @ApiTags('Suprimentos')
+@ApiInternalServerErrorResponse()
 @Controller('supplies')
 export class SupplyController {
   private logger = new Logger(SupplyController.name);
 
   constructor(private readonly supplyServices: SupplyService) {}
 
+  @ApiOkResponse()
   @Get('')
   async index() {
     try {
@@ -31,8 +40,10 @@ export class SupplyController {
     }
   }
 
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Post('')
-  async store(@Body() body) {
+  async store(@Body() body: CreateSupplyDTO) {
     try {
       const data = await this.supplyServices.store(body);
       return new ServerResponse(200, 'Successfully created supply', data);
@@ -42,8 +53,10 @@ export class SupplyController {
     }
   }
 
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Put(':id')
-  async update(@Param('id') id: string, @Body() body) {
+  async update(@Param('id') id: string, @Body() body: UpdateSupplyDTO) {
     try {
       const data = await this.supplyServices.update(id, body);
       return new ServerResponse(200, 'Successfully updated supply', data);

src/supply/supply.service.ts

@@ -1,14 +1,15 @@
-import z from 'zod';
 import { Injectable } from '@nestjs/common';
 
 import { PrismaService } from '../prisma/prisma.service';
 import { CreateSupplySchema, UpdateSupplySchema } from './types';
+import { CreateSupplyDTO } from './dtos/CreateSupplyDTO';
+import { UpdateSupplyDTO } from './dtos/UpdateSupplyDTO';
 
 @Injectable()
 export class SupplyService {
   constructor(private readonly prismaService: PrismaService) {}
 
-  async store(body: z.infer<typeof CreateSupplySchema>) {
+  async store(body: CreateSupplyDTO) {
     const payload = CreateSupplySchema.parse(body);
     return await this.prismaService.supply.create({
       data: {
@@ -18,7 +19,7 @@ export class SupplyService {
     });
   }
 
-  async update(id: string, body: z.infer<typeof UpdateSupplySchema>) {
+  async update(id: string, body: UpdateSupplyDTO) {
     const payload = UpdateSupplySchema.parse(body);
     await this.prismaService.supply.update({
       where: {