🔍 Clarify Response dto (#23)

* 🔍 Refactor responseDto.ts

* 🔍 Refactor `/request` dto

* 🔍 Refactor `/request` `/response` dto

* 🔍 Refactor response.http-response.dto.ts

* 🔍 Refactor `/user` dto

* 📜 Remove /user/create description

* 🔨 Remove /user/create header

* 📜 Add HTTP Exception description

src/HttpResponseDto.ts

@@ -0,0 +1,125 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class HttpResponseDto {
+  statusCode?: number;
+  message: string;
+  error: boolean;
+  data?: object;
+
+  constructor(
+    statusCode: number,
+    message: string,
+    error: boolean,
+    data?: object,
+  ) {
+    this.statusCode = statusCode;
+    this.message = message;
+    this.error = error;
+    this.data = data;
+  }
+}
+
+export class BadRequestDto extends HttpResponseDto {
+  @ApiProperty({
+    example: 400,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    example: 'Bad Request',
+  })
+  message: string;
+
+  @ApiProperty({
+    example: true,
+  })
+  error: boolean;
+
+  constructor(message: string) {
+    super(400, message, true);
+  }
+}
+
+export class UnauthorizedDto extends HttpResponseDto {
+  @ApiProperty({
+    example: 401,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    example: 'Unauthorized',
+  })
+  message: string;
+
+  @ApiProperty({
+    example: true,
+  })
+  error: boolean;
+
+  constructor(message: string) {
+    super(401, message, true);
+  }
+}
+
+export class ForbiddenDto extends HttpResponseDto {
+  @ApiProperty({
+    example: 403,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    example: 'Forbidden',
+  })
+  message: string;
+
+  @ApiProperty({
+    example: true,
+  })
+  error: boolean;
+
+  constructor(message: string) {
+    super(403, message, true);
+  }
+}
+
+export class NotFoundDto extends HttpResponseDto {
+  @ApiProperty({
+    example: 404,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    example: 'Not Found',
+  })
+  message: string;
+
+  @ApiProperty({
+    example: true,
+  })
+  error: boolean;
+
+  constructor(message: string) {
+    super(404, message, true);
+  }
+}
+
+export class ConflictDto extends HttpResponseDto {
+  @ApiProperty({
+    example: 409,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    example: 'Conflict',
+  })
+  message: string;
+
+  @ApiProperty({
+    example: true,
+  })
+  error: boolean;
+
+  constructor(message: string) {
+    super(409, message, true);
+  }
+}

src/request/dto/create-request.dto.ts

@@ -1,5 +1,4 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { ResponseDto } from '../../responseDto';
 
 export class CreateRequestDto {
   @ApiProperty({
@@ -45,55 +44,3 @@ export class CreateRequestDto {
   })
   problem_difficulty;
 }
-
-export class Created_CreateRequestDto extends ResponseDto {
-  @ApiProperty({
-    default: 200,
-  })
-  statusCode: number;
-
-  @ApiProperty({
-    default: '과외 요청이 성공적으로 생성되었습니다.',
-  })
-  message: string;
-
-  @ApiProperty({
-    default: false,
-  })
-  error: boolean;
-
-  @ApiProperty({
-    default: null,
-  })
-  data: object;
-
-  constructor() {
-    super(200, '과외 요청이 성공적으로 생성되었습니다.', false);
-  }
-}
-
-export class Unauthorized_CreateRequestDto extends ResponseDto {
-  @ApiProperty({
-    default: 401,
-  })
-  statusCode: number;
-
-  @ApiProperty({
-    default: '과외를 요청할 수 있는 권한이 없습니다.',
-  })
-  message: string;
-
-  @ApiProperty({
-    default: true,
-  })
-  error: boolean;
-
-  @ApiProperty({
-    default: null,
-  })
-  data: object;
-
-  constructor() {
-    super(401, '과외를 요청할 수 있는 권한이 없습니다.', true);
-  }
-}

src/request/dto/response-request.dto.ts

@@ -0,0 +1,88 @@
+import { HttpResponseDto } from '../../HttpResponseDto';
+import { ApiProperty } from '@nestjs/swagger';
+import { RequestSchema } from '../entities/request.schema';
+
+export class Created_CreateRequestDto extends HttpResponseDto {
+  @ApiProperty({
+    default: 200,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    default: '과외 요청이 성공적으로 생성되었습니다.',
+  })
+  message: string;
+
+  @ApiProperty({
+    default: false,
+  })
+  error: boolean;
+
+  constructor() {
+    super(200, '과외 요청이 성공적으로 생성되었습니다.', false);
+  }
+}
+
+export class Success_GetRequestsDto extends HttpResponseDto {
+  @ApiProperty({
+    default: 200,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    default: '과외 요청 목록을 성공적으로 가져왔습니다.',
+  })
+  @ApiProperty({
+    default: false,
+  })
+  error: boolean;
+
+  @ApiProperty({
+    type: RequestSchema,
+    default: {
+      requests: [
+        {
+          id: 'test-request-id',
+          studentId: 'test-student-id',
+          problem: {
+            description: 'test-description',
+            base64Image: 'test-base64-image',
+            schoolLevel: 'test-school-level',
+            schoolSubject: 'test-school-subject',
+            schoolChapter: 'test-school-chapter',
+            difficulty: 'test-difficulty',
+          },
+          status: 'pending',
+          tutoringId: null,
+          createdAt: '2021-01-01T00:00:00.000Z',
+        },
+      ],
+    },
+  })
+  data: typeof RequestSchema;
+
+  constructor(data: object[]) {
+    super(200, '과외 요청 목록을 성공적으로 가져왔습니다.', false, data);
+  }
+}
+
+export class Success_DeleteRequestDto extends HttpResponseDto {
+  @ApiProperty({
+    default: 200,
+  })
+  statusCode: number;
+
+  @ApiProperty({
+    default: '과외 요청이 성공적으로 삭제되었습니다.',
+  })
+  message: string;
+
+  @ApiProperty({
+    default: false,
+  })
+  error: boolean;
+
+  constructor() {
+    super(200, '과외 요청이 성공적으로 삭제되었습니다.', false);
+  }
+}