Merge pull request #21 from oodd-team/OD-38

fix: 게시글 리스트 조회 기능 수정

Author: happbob

src/post-comment/post-comment.controller.ts

@@ -42,7 +42,7 @@ export class PostCommentController {
     @Body() createCommentDto: CreateCommentDto,
     @Req() req: Request,
   ): Promise<BaseResponse<any>> {
-    const currentUserId = req.user.userId;
+    const currentUserId = req.user.id;
 
     await this.postService.validatePost(postId);
 
@@ -61,7 +61,7 @@ export class PostCommentController {
     @Query('postId') postId: number,
     @Req() req: Request,
   ): Promise<BaseResponse<GetCommentsDto>> {
-    const currentUserId = req.user.userId;
+    const currentUserId = req.user.id;
 
     const comments = await this.postCommentService.getPostComments(postId);
 
@@ -88,7 +88,7 @@ export class PostCommentController {
     commentId: number,
     @Req() req: Request,
   ): Promise<BaseResponse<PostComment>> {
-    const currentUserId = req.user.userId;
+    const currentUserId = req.user.id;
 
     await this.postCommentService.validateUser(commentId, currentUserId);
 

src/post/dtos/meta-dto-parameter.interface.ts

@@ -0,0 +1,6 @@
+import { PageOptionsDto } from './page-options.dto';
+
+export interface PageMetaDtoParameters {
+  pageOptionsDto: PageOptionsDto;
+  total: number;
+}

src/post/dtos/page-meta.dto.ts

@@ -0,0 +1,35 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { PageMetaDtoParameters } from './meta-dto-parameter.interface';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class PageMetaDto {
+  @ApiProperty({ description: '총 게시물 수', example: 100 })
+  @IsInt()
+  @IsPositive()
+  readonly total: number;
+  @ApiProperty({ description: '현재 페이지 번호', example: 1 })
+  @IsInt()
+  @IsPositive()
+  readonly page: number;
+  @ApiProperty({ description: '페이지당 게시물 수', example: 10 })
+  @IsInt()
+  @IsPositive()
+  readonly take: number;
+  @ApiProperty({ description: '마지막 페이지 번호', example: 10 })
+  @IsInt()
+  @IsPositive()
+  readonly last_page: number;
+  @ApiProperty({ description: '이전 페이지 존재 여부', example: true })
+  readonly hasPreviousPage: boolean;
+  @ApiProperty({ description: '다음 페이지 존재 여부', example: true })
+  readonly hasNextPage: boolean;
+
+  constructor({ pageOptionsDto, total }: PageMetaDtoParameters) {
+    this.page = pageOptionsDto.page <= 0 ? 1 : pageOptionsDto.page; // 페이지가 0 이하일 경우 1로 설정
+    this.take = pageOptionsDto.take;
+    this.total = total;
+    this.last_page = Math.ceil(this.total / this.take); // 마지막 페이지 계산
+    this.hasPreviousPage = this.page > 1; // 이전 페이지 여부
+    this.hasNextPage = this.page < this.last_page; // 다음 페이지 여부
+  }
+}

src/post/dtos/page-options.dto.ts

@@ -0,0 +1,30 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+import { IsInt, IsOptional, Min } from 'class-validator';
+
+export class PageOptionsDto {
+  @ApiProperty({
+    example: '1',
+    description: '페이지 번호',
+  })
+  @Type(() => Number)
+  @IsInt()
+  @IsOptional()
+  @Min(1) // 페이지는 1 이상
+  page?: number;
+
+  @ApiProperty({
+    example: '10',
+    description: '한 페이지에 불러올 데이터 개수',
+  })
+  @Type(() => Number)
+  @IsInt()
+  @IsOptional()
+  take?: number;
+
+  // 기본값 설정
+  constructor() {
+    this.page = this.page || 1;
+    this.take = this.take || 10;
+  }
+}

src/post/dtos/page.dto.ts

@@ -0,0 +1,25 @@
+import { IsArray } from 'class-validator';
+import { PageMetaDto } from './page-meta.dto';
+import { ApiProperty } from '@nestjs/swagger';
+import { GetPostsResponse } from './total-postsResponse.dto';
+import {
+  GetMyPostsResponse,
+  GetOtherPostsResponse,
+} from './user-postsResponse.dto';
+
+export class PageDto<T> {
+  @ApiProperty({
+    description: '실제 데이터',
+    type: [GetPostsResponse, GetMyPostsResponse, GetOtherPostsResponse],
+  })
+  @IsArray()
+  readonly data: T[]; // 실제 데이터
+
+  @ApiProperty({ description: '페이지 메타 정보', type: PageMetaDto })
+  readonly meta: PageMetaDto; // 메타 정보
+
+  constructor(data: T[], meta: PageMetaDto) {
+    this.data = data;
+    this.meta = meta;
+  }
+}

src/post/dtos/total-postsResponse.dto.ts

@@ -1,4 +1,5 @@
 import { ApiProperty } from '@nestjs/swagger';
+
 class PostImageDto {
   @ApiProperty({
     example: 'http://postimageurl.example',

src/post/post.controller.ts

@@ -23,13 +23,15 @@ import {
   PatchIsRepresentativeSwagger,
   PatchPostSwagger,
 } from './post.swagger';
-import { ApiBearerAuth, ApiParam, ApiTags } from '@nestjs/swagger';
+import { ApiBearerAuth, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { CreatePostDto } from './dtos/create-post.dto';
 import { BaseResponse } from 'src/common/response/dto';
 import { AuthGuard } from 'src/auth/guards/jwt.auth.guard';
 import { Request } from 'express';
 import { GetPostResponse } from './dtos/get-post.dto';
 import { PatchPostDto } from './dtos/patch-Post.dto';
+import { PageOptionsDto } from './dtos/page-options.dto';
+import { PageDto } from './dtos/page.dto';
 
 @Controller('post')
 @ApiBearerAuth()
@@ -40,21 +42,48 @@ export class PostController {
 
   @Get('/')
   @GetPostsSwagger('게시글 리스트 조회 API')
-  @ApiParam({ name: 'userId', required: false, description: 'User ID' })
+  @ApiQuery({
+    name: 'userId',
+    required: false,
+    description: 'User ID',
+    type: Number,
+  })
+  @ApiQuery({
+    name: 'page',
+    required: false,
+    description: '페이지 번호',
+    type: Number,
+  })
+  @ApiQuery({
+    name: 'take',
+    required: false,
+    description: '한 페이지에 불러올 데이터 개수',
+  })
   async getPosts(
     @Req() req: Request,
+    @Query() pageOptionsDto?: PageOptionsDto,
     @Query('userId') userId?: number,
   ): Promise<
-    BaseResponse<GetPostsResponse | GetMyPostsResponse | GetOtherPostsResponse>
+    BaseResponse<
+      PageDto<GetPostsResponse | GetMyPostsResponse | GetOtherPostsResponse>
+    >
   > {
     const currentUserId = req.user.id;
 
+    const options = pageOptionsDto
+      ? {
+          ...new PageOptionsDto(),
+          ...pageOptionsDto, // Dto에 전달된 기본값
+        }
+      : new PageOptionsDto();
+
     const postsResponse = await this.postService.getPosts(
+      options,
       userId,
       currentUserId,
     );
 
-    return new BaseResponse(true, 'SUCCESS', postsResponse);
+    return new BaseResponse(true, '게시글 리스트 조회 성공', postsResponse);
   }
 
   @Get(':postId')