Merge pull request #451 from boostcampwm-2024/refactor/api

♻️ refactor: API Response, Request DTO 구현, ApiProperty 추가

Author: Jo-Minseok

server/src/activity/controller/activity.controller.ts

@@ -1,6 +1,12 @@
-import { Controller, Get, Param, Query } from '@nestjs/common';
+import {
+  Controller,
+  Get,
+  HttpCode,
+  HttpStatus,
+  Param,
+  Query,
+} from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
-
 import { ActivityService } from '../service/activity.service';
 import { ApiResponse } from '../../common/response/common.response';
 import { ActivityParamRequestDto } from '../dto/request/activity-param.dto';
@@ -14,6 +20,7 @@ export class ActivityController {
 
   @ApiReadActivities()
   @Get(':userId')
+  @HttpCode(HttpStatus.OK)
   async readActivities(
     @Param() paramDto: ActivityParamRequestDto,
     @Query() queryDto: ActivityQueryRequestDto,

server/src/activity/dto/request/activity-param.dto.ts

@@ -10,7 +10,7 @@ export class ActivityParamRequestDto {
   @IsInt({
     message: '정수를 입력해주세요.',
   })
-  @Min(1, { message: '사용자 ID는 1보다 커야합니다.' })
+  @Min(1, { message: '사용자 ID는 1 이상이어야 합니다.' })
   @Type(() => Number)
   userId: number;
 

server/src/activity/dto/response/activity-read.dto.ts

@@ -1,16 +1,8 @@
 import { ApiProperty } from '@nestjs/swagger';
+import { User } from '../../../user/entity/user.entity';
 
 export class DailyActivityDto {
-  @ApiProperty({
-    example: '2024-01-15',
-    description: '활동 날짜 (YYYY-MM-DD)',
-  })
   date: string;
-
-  @ApiProperty({
-    example: 5,
-    description: '해당 날짜의 조회수',
-  })
   viewCount: number;
 
   constructor(partial: Partial<DailyActivityDto>) {
@@ -43,7 +35,16 @@ export class ActivityReadResponseDto {
   })
   totalViews: number;
 
-  constructor(partial: Partial<ActivityReadResponseDto>) {
+  private constructor(partial: Partial<ActivityReadResponseDto>) {
     Object.assign(this, partial);
   }
+
+  static toResponseDto(dailyActivities: DailyActivityDto[], user: User) {
+    return new ActivityReadResponseDto({
+      dailyActivities: dailyActivities,
+      maxStreak: user.maxStreak,
+      currentStreak: user.currentStreak,
+      totalViews: user.totalViews,
+    });
+  }
 }

server/src/activity/service/activity.service.ts

@@ -1,26 +1,23 @@
-import { Injectable, NotFoundException } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { ActivityRepository } from '../repository/activity.repository';
-import { UserRepository } from '../../user/repository/user.repository';
 import {
   ActivityReadResponseDto,
   DailyActivityDto,
 } from '../dto/response/activity-read.dto';
+import { UserService } from '../../user/service/user.service';
 
 @Injectable()
 export class ActivityService {
   constructor(
     private readonly activityRepository: ActivityRepository,
-    private readonly userRepository: UserRepository,
+    private readonly userService: UserService,
   ) {}
 
   async readActivities(
     userId: number,
     year: number,
   ): Promise<ActivityReadResponseDto> {
-    const user = await this.userRepository.findOneBy({ id: userId });
-    if (!user) {
-      throw new NotFoundException('존재하지 않는 사용자입니다.');
-    }
+    const user = await this.userService.getUser(userId);
 
     const activities =
       await this.activityRepository.findActivitiesByUserIdAndYear(userId, year);
@@ -33,12 +30,7 @@ export class ActivityService {
         }),
     );
 
-    return new ActivityReadResponseDto({
-      dailyActivities,
-      maxStreak: user.maxStreak,
-      currentStreak: user.currentStreak,
-      totalViews: user.totalViews,
-    });
+    return ActivityReadResponseDto.toResponseDto(dailyActivities, user);
   }
 
   async upsertActivity(userId: number) {

server/src/admin/controller/admin.controller.ts

@@ -57,6 +57,7 @@ export class AdminController {
   @ApiCreateAdmin()
   @UseGuards(AdminAuthGuard)
   @Post('/register')
+  @HttpCode(HttpStatus.CREATED)
   async createAdmin(@Body() registerAdminBodyDto: RegisterAdminRequestDto) {
     await this.adminService.createAdmin(registerAdminBodyDto);
     return ApiResponse.responseWithNoContent(

server/src/chat/service/chat.service.ts

@@ -11,8 +11,6 @@ const CHAT_HISTORY_LIMIT = 20;
 
 @Injectable()
 export class ChatService {
-  private dayInit: boolean = false;
-
   constructor(private readonly redisService: RedisService) {}
 
   isMaxClientExceeded(userCount: number) {

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

@@ -1,5 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsInt, IsNotEmpty, IsString } from 'class-validator';
+import { IsInt, IsNotEmpty, IsString, Min } from 'class-validator';
 
 export class CreateCommentRequestDto {
   @ApiProperty({
@@ -13,13 +13,13 @@ export class CreateCommentRequestDto {
   comment: string;
 
   @ApiProperty({
-    example: '1',
+    example: 1,
     description: '게시글 번호를 입력해주세요.',
   })
   @IsInt({
     message: '숫자로 입력해주세요.',
   })
-  @IsNotEmpty({ message: '피드 아이디를 입력하세요.' })
+  @Min(1, { message: '게시글 ID는 1 이상이어야 합니다.' })
   feedId: number;
 
   constructor(partial: Partial<CreateCommentRequestDto>) {

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

@@ -1,15 +1,15 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsInt, IsNotEmpty } from 'class-validator';
+import { IsInt, Min } from 'class-validator';
 
 export class DeleteCommentRequestDto {
   @ApiProperty({
-    example: '1',
+    example: 1,
     description: '댓글 번호를 입력해주세요.',
   })
   @IsInt({
     message: '숫자로 입력해주세요.',
   })
-  @IsNotEmpty({ message: '댓글 아이디를 입력하세요.' })
+  @Min(1, { message: '댓글 ID는 1 이상이어야 합니다.' })
   commentId: number;
 
   constructor(partial: Partial<DeleteCommentRequestDto>) {

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

@@ -1,16 +1,17 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
-import { IsInt } from 'class-validator';
+import { IsInt, Min } from 'class-validator';
 
 export class GetCommentRequestDto {
   @ApiProperty({
-    example: '게시글 ID',
+    example: 1,
     description: '게시글 ID를 입력해주세요',
   })
   @IsInt({
     message: '숫자로 입력해주세요.',
   })
   @Type(() => Number)
+  @Min(1, { message: '댓글 ID는 1 이상이어야 합니다.' })
   feedId: number;
 
   constructor(partial: Partial<GetCommentRequestDto>) {

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

@@ -1,15 +1,15 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { IsInt, IsNotEmpty, IsString } from 'class-validator';
+import { IsInt, IsNotEmpty, IsString, Min } from 'class-validator';
 
 export class UpdateCommentRequestDto {
   @ApiProperty({
-    example: '댓글 번호',
+    example: 1,
     description: '댓글 번호를 입력해주세요.',
   })
   @IsInt({
     message: '정수로 입력하세요.',
   })
-  @IsNotEmpty({ message: '댓글 아이디를 입력하세요.' })
+  @Min(1, { message: '댓글 ID는 1 이상이어야 합니다.' })
   commentId: number;
 
   @ApiProperty({