feat: response dto 생성 및 swagger return type 적용

Author: ezcolin2

backend/db_name

@@ -0,0 +1,26 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, IsNumber, IsObject } from 'class-validator';
+class Coordinate {
+  @IsNumber()
+  x: number;
+  @IsNumber()
+  y: number;
+}
+export class CoordinateResponseDto {
+  @ApiProperty({
+    example: 'OO 생성에 성공했습니다.',
+    description: 'api 요청 결과 메시지',
+  })
+  @IsString()
+  message: string;
+
+  @ApiProperty({
+    example: {
+      x: 14,
+      y: 14,
+    },
+    description: 'api 요청 결과 메시지',
+  })
+  @IsObject()
+  coordinate: Coordinate;
+}

backend/src/node/dtos/coordinateResponse.dto.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+
+export class MessageResponseDto {
+  @ApiProperty({
+    example: 'OO 생성에 성공했습니다.',
+    description: 'api 요청 결과 메시지',
+  })
+  @IsString()
+  message: string;
+}

backend/src/node/dtos/messageResponse.dto.ts

@@ -13,7 +13,9 @@ import {
 import { NodeService } from './node.service';
 import { CreateNodeDto } from './dtos/createNode.dto';
 import { UpdateNodeDto } from './dtos/updateNode.dto';
-import { ApiOperation } from '@nestjs/swagger';
+import { ApiOperation, ApiResponse } from '@nestjs/swagger';
+import { MessageResponseDto } from './dtos/messageResponse.dto';
+import { CoordinateResponseDto } from './dtos/coordinateResponse.dto';
 
 export enum NodeResponseMessage {
   NODE_CREATED = '노드와 페이지를 생성했습니다.',
@@ -26,6 +28,9 @@ export enum NodeResponseMessage {
 export class NodeController {
   constructor(private readonly nodeService: NodeService) {}
 
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({ summary: '노드를 생성하면서 페이지도 함께 생성합니다.' })
   @Post('/')
   @HttpCode(HttpStatus.CREATED)
@@ -35,7 +40,9 @@ export class NodeController {
       message: NodeResponseMessage.NODE_CREATED,
     };
   }
-
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({
     summary: '노드를 삭제하면서 페이지도 삭제합니다. (delete: cascade)',
   })
@@ -47,7 +54,9 @@ export class NodeController {
       message: NodeResponseMessage.NODE_DELETED,
     };
   }
-
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({ summary: '노드의 제목, 좌표를 수정합니다.' })
   @Patch('/:id')
   @HttpCode(HttpStatus.OK)
@@ -60,7 +69,9 @@ export class NodeController {
       message: NodeResponseMessage.NODE_UPDATED,
     };
   }
-
+  @ApiResponse({
+    type: CoordinateResponseDto,
+  })
   @ApiOperation({ summary: '노드의 좌표를 가져옵니다.' })
   @Get(':id/coordinates')
   @HttpCode(HttpStatus.OK)

backend/src/node/node.controller.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, IsArray, IsObject } from 'class-validator';
+import { Page } from '../page.entity';
+
+export class FindPageResponseDto {
+  @ApiProperty({
+    example: 'OO 생성에 성공했습니다.',
+    description: 'api 요청 결과 메시지',
+  })
+  @IsString()
+  message: string;
+
+  @ApiProperty({
+    example: {
+      type: 'doc',
+      content: {},
+    },
+    description: '모든 Page 배열',
+  })
+  @IsObject()
+  page: Partial<Page>;
+}

backend/src/page/dtos/findPageResponse.dto.ts

@@ -0,0 +1,28 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, IsArray } from 'class-validator';
+import { Page } from '../page.entity';
+
+export class FindPagesResponseDto {
+  @ApiProperty({
+    example: 'OO 생성에 성공했습니다.',
+    description: 'api 요청 결과 메시지',
+  })
+  @IsString()
+  message: string;
+
+  @ApiProperty({
+    example: [
+      {
+        id: 1,
+        title: '페이지 제목',
+        content: {
+          type: 'doc',
+          content: {},
+        },
+      },
+    ],
+    description: '모든 Page 배열',
+  })
+  @IsArray()
+  pages: Partial<Page>[];
+}

backend/src/page/dtos/findPagesResponse.dto.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString } from 'class-validator';
+
+export class MessageResponseDto {
+  @ApiProperty({
+    example: 'OO 생성에 성공했습니다.',
+    description: 'api 요청 결과 메시지',
+  })
+  @IsString()
+  message: string;
+}

backend/src/page/dtos/messageResponse.dto.ts

@@ -14,6 +14,9 @@ import { PageService } from './page.service';
 import { CreatePageDto } from './dtos/createPage.dto';
 import { UpdatePageDto } from './dtos/updatePage.dto';
 import { ApiBody, ApiOperation, ApiResponse } from '@nestjs/swagger';
+import { MessageResponseDto } from './dtos/messageResponse.dto';
+import { FindPagesResponseDto } from './dtos/findPagesResponse.dto';
+import { FindPageResponseDto } from './dtos/findPageResponse.dto';
 
 export enum PageResponseMessage {
   PAGE_CREATED = '페이지와 노드를 생성했습니다.',
@@ -26,60 +29,74 @@ export enum PageResponseMessage {
 @Controller('page')
 export class PageController {
   constructor(private readonly pageService: PageService) {}
-
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({ summary: '페이지를 생성하고 노드도 생성합니다.' })
   @ApiBody({
     description: 'post',
     type: CreatePageDto,
   })
   @Post('/')
   @HttpCode(HttpStatus.CREATED)
-  async createPage(@Body() body: CreatePageDto): Promise<{ message: string }> {
+  async createPage(@Body() body: CreatePageDto): Promise<MessageResponseDto> {
     await this.pageService.createPage(body);
     return {
       message: PageResponseMessage.PAGE_CREATED,
     };
   }
 
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({
     summary: '페이지를 삭제하고 노드도 삭제합니다. (cascade delete)',
   })
   @Delete('/:id')
   @HttpCode(HttpStatus.OK)
-  async deletePage(@Param('id') id: number): Promise<{ message: string }> {
+  async deletePage(@Param('id') id: number): Promise<MessageResponseDto> {
     await this.pageService.deletePage(id);
     return {
       message: PageResponseMessage.PAGE_DELETED,
     };
   }
+
+  @ApiResponse({
+    type: MessageResponseDto,
+  })
   @ApiOperation({ summary: '페이지 제목, 내용을 수정합니다.' })
   @Patch('/:id')
   @HttpCode(HttpStatus.OK)
   async updatePage(
     @Param('id') id: number,
     @Body() body: UpdatePageDto,
-  ): Promise<{ message: string }> {
+  ): Promise<MessageResponseDto> {
     await this.pageService.updatePage(id, body);
     return {
       message: PageResponseMessage.PAGE_UPDATED,
     };
   }
 
+  @ApiResponse({
+    type: FindPagesResponseDto,
+  })
   @ApiOperation({ summary: '모든 페이지를 가져옵니다.' })
   @Get()
   @HttpCode(HttpStatus.OK)
-  async findPages(): Promise<{ message: string; pages: Partial<Page>[] }> {
+  async findPages(): Promise<FindPagesResponseDto> {
     return {
       message: PageResponseMessage.PAGE_LIST_RETURNED,
       pages: await this.pageService.findPages(),
     };
   }
+
+  @ApiResponse({
+    type: FindPageResponseDto,
+  })
   @ApiOperation({ summary: '특정 페이지를 가져옵니다.' })
   @Get('/:id')
   @HttpCode(HttpStatus.OK)
-  async findPage(
-    @Param('id') id: number,
-  ): Promise<{ message: string; page: Page }> {
+  async findPage(@Param('id') id: number): Promise<FindPageResponseDto> {
     return {
       message: PageResponseMessage.PAGE_RETURNED,
       page: await this.pageService.findPageById(id),