Merge pull request #385 from boostcampwm-2024/feat/comment

✨ feat: 댓글 등록, 수정, 삭제 기능 API 및 테스트 코드 작성

Author: Jo-Minseok

server/src/admin/module/admin.module.ts

@@ -7,5 +7,6 @@ import { AdminRepository } from '../repository/admin.repository';
   imports: [],
   controllers: [AdminController],
   providers: [AdminService, AdminRepository],
+  exports: [AdminRepository],
 })
 export class AdminModule {}

server/src/app.module.ts

@@ -13,6 +13,7 @@ import { TestModule } from './common/test/test.module';
 import { UserModule } from './user/module/user.module';
 import { ActivityModule } from './activity/module/activity.module';
 import { EmailModule } from './common/email/email.module';
+import { CommentModule } from './comment/module/comment.module';
 
 @Module({
   imports: [
@@ -42,6 +43,7 @@ import { EmailModule } from './common/email/email.module';
     TestModule,
     StatisticModule,
     EmailModule,
+    CommentModule,
   ],
   controllers: [],
   providers: [],

server/src/comment/api-docs/createComment.api-docs.ts

@@ -0,0 +1,40 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+  ApiBadRequestResponse,
+  ApiCreatedResponse,
+  ApiOperation,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
+
+export function ApiCreateComment() {
+  return applyDecorators(
+    ApiOperation({
+      summary: '댓글 등록 API',
+    }),
+    ApiCreatedResponse({
+      description: 'Created',
+      schema: {
+        properties: {
+          message: {
+            type: 'string',
+          },
+        },
+      },
+      example: {
+        message: '댓글 등록을 성공했습니다.',
+      },
+    }),
+    ApiBadRequestResponse({
+      description: 'Bad Request',
+      example: {
+        message: '오류 메세지',
+      },
+    }),
+    ApiUnauthorizedResponse({
+      description: 'Unauthorized',
+      example: {
+        message: '인증되지 않은 요청입니다.',
+      },
+    }),
+  );
+}

server/src/comment/api-docs/deleteComment.api-docs.ts

@@ -0,0 +1,40 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+  ApiBadRequestResponse,
+  ApiOkResponse,
+  ApiOperation,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
+
+export function ApiDeleteComment() {
+  return applyDecorators(
+    ApiOperation({
+      summary: '댓글 삭제 API',
+    }),
+    ApiOkResponse({
+      description: 'Ok',
+      schema: {
+        properties: {
+          message: {
+            type: 'string',
+          },
+        },
+      },
+      example: {
+        message: '댓글 삭제를 성공했습니다.',
+      },
+    }),
+    ApiBadRequestResponse({
+      description: 'Bad Request',
+      example: {
+        message: '오류 메세지',
+      },
+    }),
+    ApiUnauthorizedResponse({
+      description: 'Unauthorized',
+      example: {
+        message: '인증되지 않은 요청입니다.',
+      },
+    }),
+  );
+}

server/src/comment/api-docs/updateComment.api-docs.ts

@@ -0,0 +1,40 @@
+import { applyDecorators } from '@nestjs/common';
+import {
+  ApiBadRequestResponse,
+  ApiOkResponse,
+  ApiOperation,
+  ApiUnauthorizedResponse,
+} from '@nestjs/swagger';
+
+export function ApiUpdateComment() {
+  return applyDecorators(
+    ApiOperation({
+      summary: '댓글 수정 API',
+    }),
+    ApiOkResponse({
+      description: 'Ok',
+      schema: {
+        properties: {
+          message: {
+            type: 'string',
+          },
+        },
+      },
+      example: {
+        message: '댓글을 수정을 성공했습니다.',
+      },
+    }),
+    ApiBadRequestResponse({
+      description: 'Bad Request',
+      example: {
+        message: '오류 메세지',
+      },
+    }),
+    ApiUnauthorizedResponse({
+      description: 'Unauthorized',
+      example: {
+        message: '인증되지 않은 요청입니다.',
+      },
+    }),
+  );
+}

server/src/comment/controller/comment.controller.ts

@@ -0,0 +1,52 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  HttpCode,
+  HttpStatus,
+  Patch,
+  Post,
+  Req,
+  UseGuards,
+} from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+import { CommentService } from '../service/comment.service';
+import { ApiCreateComment } from '../api-docs/createComment.api-docs';
+import { ApiDeleteComment } from '../api-docs/deleteComment.api-docs';
+import { ApiUpdateComment } from '../api-docs/updateComment.api-docs';
+import { JwtGuard } from '../../common/guard/jwt.guard';
+import { ApiResponse } from '../../common/response/common.response';
+import { CreateCommentRequestDto } from '../dto/request/create-comment.dto';
+import { DeleteCommentRequestDto } from '../dto/request/delete-comment.dto';
+import { UpdateCommentRequestDto } from '../dto/request/update-comment.dto';
+
+@ApiTags('Comment')
+@Controller('comment')
+@UseGuards(JwtGuard)
+export class CommentController {
+  constructor(private readonly commentService: CommentService) {}
+
+  @ApiCreateComment()
+  @Post()
+  @HttpCode(HttpStatus.CREATED)
+  async createComment(@Req() req, @Body() commentDto: CreateCommentRequestDto) {
+    await this.commentService.create(req.user, commentDto);
+    return ApiResponse.responseWithNoContent('댓글 등록을 성공했습니다.');
+  }
+
+  @ApiDeleteComment()
+  @Delete()
+  @HttpCode(HttpStatus.OK)
+  async deleteComment(@Req() req, @Body() commentDto: DeleteCommentRequestDto) {
+    await this.commentService.delete(req.user, commentDto);
+    return ApiResponse.responseWithNoContent('댓글 삭제를 성공했습니다.');
+  }
+
+  @ApiUpdateComment()
+  @Patch()
+  @HttpCode(HttpStatus.OK)
+  async updateComment(@Req() req, @Body() commentDto: UpdateCommentRequestDto) {
+    await this.commentService.update(req.user, commentDto);
+    return ApiResponse.responseWithNoContent('댓글 수정을 성공했습니다.');
+  }
+}

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

@@ -0,0 +1,28 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsInt, IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateCommentRequestDto {
+  @ApiProperty({
+    example: '댓글 내용',
+    description: '댓글 내용을 입력해주세요.',
+  })
+  @IsString({
+    message: '문자열을 입력해주세요',
+  })
+  @IsNotEmpty({ message: '댓글 내용을 입력하세요.' })
+  comment: string;
+
+  @ApiProperty({
+    example: '1',
+    description: '게시글 번호를 입력해주세요.',
+  })
+  @IsInt({
+    message: '숫자로 입력해주세요.',
+  })
+  @IsNotEmpty({ message: '피드 아이디를 입력하세요.' })
+  feedId: number;
+
+  constructor(partial: Partial<CreateCommentRequestDto>) {
+    Object.assign(this, partial);
+  }
+}

server/src/comment/dto/request/delete-comment.dto.ts

@@ -0,0 +1,18 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsInt, IsNotEmpty } from 'class-validator';
+
+export class DeleteCommentRequestDto {
+  @ApiProperty({
+    example: '1',
+    description: '댓글 번호를 입력해주세요.',
+  })
+  @IsInt({
+    message: '숫자로 입력해주세요.',
+  })
+  @IsNotEmpty({ message: '댓글 아이디를 입력하세요.' })
+  commentId: number;
+
+  constructor(partial: Partial<DeleteCommentRequestDto>) {
+    Object.assign(this, partial);
+  }
+}

server/src/comment/dto/request/update-comment.dto.ts

@@ -0,0 +1,28 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsInt, IsNotEmpty, IsString } from 'class-validator';
+
+export class UpdateCommentRequestDto {
+  @ApiProperty({
+    example: '댓글 번호',
+    description: '댓글 번호를 입력해주세요.',
+  })
+  @IsInt({
+    message: '정수로 입력하세요.',
+  })
+  @IsNotEmpty({ message: '댓글 아이디를 입력하세요.' })
+  commentId: number;
+
+  @ApiProperty({
+    example: '수정할 내용',
+    description: '수정할 내용을 입력해주세요.',
+  })
+  @IsString({
+    message: '문자열을 입력하세요.',
+  })
+  @IsNotEmpty({ message: '댓글 내용을 입력하세요.' })
+  newComment: string;
+
+  constructor(partial: Partial<UpdateCommentRequestDto>) {
+    Object.assign(this, partial);
+  }
+}

server/src/comment/entity/comment.entity.ts

@@ -0,0 +1,50 @@
+import {
+  BaseEntity,
+  Column,
+  CreateDateColumn,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+} from 'typeorm';
+import { Feed } from '../../feed/entity/feed.entity';
+import { User } from '../../user/entity/user.entity';
+
+@Entity({ name: 'comment' })
+export class Comment extends BaseEntity {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column({
+    name: 'comment',
+    nullable: false,
+    type: 'text',
+  })
+  comment: string;
+
+  @CreateDateColumn({
+    name: 'date',
+    nullable: false,
+  })
+  date: Date;
+
+  @ManyToOne(() => Feed, (feed) => feed.id, {
+    nullable: false,
+    onUpdate: 'CASCADE',
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({
+    name: 'feed_id',
+  })
+  feed: Feed;
+
+  @ManyToOne(() => User, (user) => user.id, {
+    nullable: false,
+    onUpdate: 'CASCADE',
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({
+    name: 'user_id',
+  })
+  user: User;
+}