feat: add req body validation & swagger docs to supply-categories routes

Author: ocsoares

src/supply-categories/dtos/CreateSupplyCategoryDTO.ts

@@ -0,0 +1,9 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateSupplyCategoryDTO {
+  @ApiProperty({ type: 'string', example: 'Nome da categoria do suprimento' })
+  @IsNotEmpty()
+  @IsString()
+  readonly name = '';
+}

src/supply-categories/dtos/UpdateSupplyCategoryDTO.ts

@@ -0,0 +1,13 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsOptional, IsString } from 'class-validator';
+
+export class UpdateSupplyCategoryDTO {
+  @ApiProperty({
+    required: false,
+    type: 'string',
+    example: 'Nome da categoria do suprimento',
+  })
+  @IsOptional()
+  @IsString()
+  readonly name?: string;
+}

src/supply-categories/supply-categories.controller.ts

@@ -9,13 +9,23 @@ import {
   Put,
   UseGuards,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import {
+  ApiBadRequestResponse,
+  ApiBearerAuth,
+  ApiInternalServerErrorResponse,
+  ApiOkResponse,
+  ApiTags,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
 
 import { SupplyCategoriesService } from './supply-categories.service';
 import { ServerResponse } from '../utils';
 import { AdminGuard } from '@/guards/admin.guard';
+import { CreateSupplyCategoryDTO } from './dtos/CreateSupplyCategoryDTO';
+import { UpdateSupplyCategoryDTO } from './dtos/UpdateSupplyCategoryDTO';
 
 @ApiTags('Categoria de Suprimentos')
+@ApiInternalServerErrorResponse()
 @Controller('supply-categories')
 export class SupplyCategoriesController {
   private logger = new Logger(SupplyCategoriesController.name);
@@ -24,6 +34,7 @@ export class SupplyCategoriesController {
     private readonly supplyCategoryServices: SupplyCategoriesService,
   ) {}
 
+  @ApiOkResponse()
   @Get('')
   async index() {
     try {
@@ -39,9 +50,13 @@ export class SupplyCategoriesController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Post('')
   @UseGuards(AdminGuard)
-  async store(@Body() body) {
+  async store(@Body() body: CreateSupplyCategoryDTO) {
     try {
       const data = await this.supplyCategoryServices.store(body);
       return new ServerResponse(
@@ -55,9 +70,13 @@ export class SupplyCategoriesController {
     }
   }
 
+  @ApiBearerAuth()
+  @ApiUnauthorizedResponse()
+  @ApiBadRequestResponse()
+  @ApiOkResponse()
   @Put(':id')
   @UseGuards(AdminGuard)
-  async update(@Param('id') id: string, @Body() body) {
+  async update(@Param('id') id: string, @Body() body: UpdateSupplyCategoryDTO) {
     try {
       const data = await this.supplyCategoryServices.update(id, body);
       return new ServerResponse(

src/supply-categories/supply-categories.service.ts

@@ -1,17 +1,18 @@
 import { Injectable } from '@nestjs/common';
 
 import { PrismaService } from '../prisma/prisma.service';
-import { z } from 'zod';
 import {
   CreateSupplyCategorySchema,
   UpdateSupplyCategorySchema,
 } from './types';
+import { CreateSupplyCategoryDTO } from './dtos/CreateSupplyCategoryDTO';
+import { UpdateSupplyCategoryDTO } from './dtos/UpdateSupplyCategoryDTO';
 
 @Injectable()
 export class SupplyCategoriesService {
   constructor(private readonly prismaService: PrismaService) {}
 
-  async store(body: z.infer<typeof CreateSupplyCategorySchema>) {
+  async store(body: CreateSupplyCategoryDTO) {
     const payload = CreateSupplyCategorySchema.parse(body);
     await this.prismaService.supplyCategory.create({
       data: {
@@ -21,7 +22,7 @@ export class SupplyCategoriesService {
     });
   }
 
-  async update(id: string, body: z.infer<typeof UpdateSupplyCategorySchema>) {
+  async update(id: string, body: UpdateSupplyCategoryDTO) {
     const payload = UpdateSupplyCategorySchema.parse(body);
     await this.prismaService.supplyCategory.update({
       where: {