[백한결] 인스타 스토리 API

template/source/typeorm/app.module.ts → src/app.module.ts

@@ -3,6 +3,9 @@ import { TypeOrmModule } from '@nestjs/typeorm';
 import { ConfigModule } from '@nestjs/config';
 import { addTransactionalDataSource } from 'typeorm-transactional';
 import { DataSource } from 'typeorm';
+import { StoryModule } from './story/story.module';
+import { Story } from './story/entities/story.entity';
+import { Hashtag } from './hashtag/entity/hashtag.entity';
 
 @Module({
   imports: [
@@ -17,6 +20,7 @@ import { DataSource } from 'typeorm';
           password: process.env.DB_PASSWORD,
           database: process.env.DB_DATABASE,
           synchronize: process.env.DB_SYNC === 'true',
+          entities: [Story, Hashtag],
           timezone: 'Z',
         };
       },
@@ -28,6 +32,7 @@ import { DataSource } from 'typeorm';
         return addTransactionalDataSource(new DataSource(options));
       },
     }),
+    StoryModule,
   ],
   controllers: [],
   providers: [],

src/common/dto/pagination.dto.ts

@@ -0,0 +1,19 @@
+import { IsInt } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+
+export class PaginationDto {
+  @Type(() => Number)
+  @IsInt()
+  @ApiProperty({
+    example: 1
+  })
+  page: number = 1;
+
+  @Type(() => Number)
+  @IsInt()
+  @ApiProperty({
+    example: 10
+  })
+  limit: number = 10;
+}

src/common/utils/pagination.util.ts

@@ -0,0 +1,23 @@
+export class PaginationResult<T> {
+  data: T[];
+  page: number;
+  limit: number;
+  totalCount: number;
+  totalPages: number;
+
+  constructor(data: T[], page: number, limit: number, totalCount: number) {
+    this.data = data;
+    this.page = page;
+    this.limit = limit;
+    this.totalPages = Math.ceil(totalCount / limit);
+  }
+}
+
+export function createPaginationResult<T>(
+  data: T[],
+  page: number,
+  limit: number,
+  totalCount: number,
+): PaginationResult<T> {
+  return new PaginationResult(data, page, limit, totalCount);
+}

src/hashtag/entity/hashtag.entity.ts

@@ -0,0 +1,14 @@
+import { Column, Entity, ManyToMany, PrimaryGeneratedColumn } from 'typeorm';
+import { Story } from '../../story/entities/story.entity';
+
+@Entity()
+export class Hashtag {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  hashtag: string;
+
+  @ManyToMany(() => Story, (story) => story.hashtags)
+  stories: Story[];
+}

src/main.ts

@@ -0,0 +1,38 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { initializeTransactionalContext } from 'typeorm-transactional';
+import { ValidationPipe } from '@nestjs/common';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+
+async function bootstrap() {
+  initializeTransactionalContext();
+
+  const app = await NestFactory.create(AppModule);
+
+  app.useGlobalPipes(
+    new ValidationPipe({
+      whitelist: true,
+      forbidNonWhitelisted: true,
+      transform: true,
+    }),
+  )
+  // TODO: 프로그램 구현
+
+  // Swagger
+  const config = new DocumentBuilder()
+    .setTitle('어쩌다Nest 과제')
+    .setDescription('어쩌다Nest 과제 API')
+    .setVersion('1.0')
+    .build();
+  const swaggerOptions = {
+    operationIdFactory: (controllerKey: string, methodKey: string) => methodKey,
+  };
+  const document = SwaggerModule.createDocument(app, config, swaggerOptions);
+  SwaggerModule.setup('api', app, document);
+
+  await app.listen(process.env.PORT || 8000);
+
+  console.log(`Application is running on: ${await app.getUrl()}`);
+}
+
+bootstrap();

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

@@ -0,0 +1,40 @@
+import { IsIn, IsInt, IsString, IsUrl, Matches } from 'class-validator';
+import { ApiProperty } from '@nestjs/swagger';
+
+export class CreateStoryRequestDto {
+
+  @IsInt()
+  @IsIn([12, 24], {
+    message: 'validTime은 12시간 또는 24시간으로 설정 가능합니다.',
+  })
+  @ApiProperty({
+    description: '유효시간은 12시간 또는 24시간으로 설정 가능합니다.',
+    example: 12
+  })
+  validTime: number;
+
+  @IsString()
+  @ApiProperty({
+    example: '어쩌다 Nest'
+  })
+  title: string;
+
+  @IsString()
+  @ApiProperty({
+    example: '어쩌다'
+  })
+  author: string;
+
+  @IsUrl()
+  @ApiProperty({
+    example: 'https://example.com/image.jpg'
+  })
+  image: string;
+
+  @IsString({ each: true })
+  @Matches(/#[^\s#]+/g, { each: true, message: '모든 해시태그는 #으로 시작해야 합니다.' })
+  @ApiProperty({
+    example: ['#어쩌다', '#Nest', '#당근']
+  })
+  hashtags: string[];
+}

src/story/dto/response/create-story-response.dto.ts

@@ -0,0 +1,23 @@
+import { Story } from '../../entities/story.entity';
+
+export class CreateStoryResponseDto {
+  id: number;
+  createdAt: Date;
+  validTime: number;
+  title: string;
+  author: string;
+  image: string;
+  hashtags: string[];
+
+  public static fromEntity(entity: Story): CreateStoryResponseDto {
+    const dto = new CreateStoryResponseDto();
+    dto.id = entity.id;
+    dto.createdAt = entity.createdAt;
+    dto.validTime = entity.validTime;
+    dto.title = entity.title;
+    dto.author = entity.author;
+    dto.image = entity.image;
+    dto.hashtags = entity.hashtags.map(hashtag => hashtag.hashtag);
+    return dto;
+  }
+}

src/story/entities/story.entity.ts

@@ -0,0 +1,27 @@
+import { Column, CreateDateColumn, Entity, JoinTable, ManyToMany, PrimaryGeneratedColumn } from 'typeorm';
+import { Hashtag } from '../../hashtag/entity/hashtag.entity';
+
+@Entity()
+export class Story {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @Column()
+  validTime: number;
+
+  @Column()
+  title: string;
+
+  @Column()
+  author: string;
+
+  @Column()
+  image: string;
+
+  @ManyToMany(() => Hashtag)
+  @JoinTable()
+  hashtags: Hashtag[];
+}

src/story/story.controller.spec.ts

@@ -0,0 +1,74 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { StoryController } from './story.controller';
+import { StoryService } from './story.service';
+import { CreateStoryRequestDto } from './dto/request/create-story-request.dto';
+import { PaginationDto } from '../common/dto/pagination.dto';
+
+describe('StoryController', () => {
+  let controller: StoryController;
+  let storyService: StoryService;
+
+  beforeEach(async () => {
+    const mockStoryService = {
+      createStory: jest.fn(dto => {
+        return {
+          id: Date.now(),
+          ...dto
+        };
+      }),
+      getStories: jest.fn(dto => {
+        return {
+          data: [],
+          page: dto.page,
+          limit: dto.limit,
+          totalCount: 0,
+          totalPages: 0,
+        };
+      }),
+    };
+
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [StoryController],
+      providers: [{ provide: StoryService, useValue: mockStoryService }],
+    }).compile();
+
+    controller = module.get<StoryController>(StoryController);
+    storyService = module.get<StoryService>(StoryService);
+  });
+
+  describe('스토리 생성', () => {
+    it('스토리를 생성하고 반환해야 함', async () => {
+      const requestDto: CreateStoryRequestDto = {
+        validTime: 24,
+        title: 'test',
+        author: 'Author',
+        image: 'http://example.com/image.jpg',
+        hashtags: ['#test', '#nestjs'],
+      };
+
+      expect(await controller.createStory(requestDto)).toEqual({
+        id: expect.any(Number),
+        ...requestDto,
+      });
+      expect(storyService.createStory).toHaveBeenCalledWith(requestDto);
+    });
+  });
+
+  describe('스토리 목록 조회', () => {
+    it('스토리 목록과 페이지네이션 결과를 반환해야 함', async () => {
+      const requestDto: PaginationDto = {
+        page: 1,
+        limit: 10,
+      };
+
+      expect(await controller.getStories(requestDto)).toEqual({
+        data: [],
+        page: requestDto.page,
+        limit: requestDto.limit,
+        totalCount: 0,
+        totalPages: 0,
+      });
+      expect(storyService.getStories).toHaveBeenCalledWith(requestDto);
+    });
+  });
+});

src/story/story.controller.ts

@@ -0,0 +1,33 @@
+import { Controller, Get, Post, Body, Patch, Param, Delete, HttpCode, HttpStatus, Query } from '@nestjs/common';
+import { StoryService } from './story.service';
+import { CreateStoryRequestDto } from './dto/request/create-story-request.dto';
+import { PaginationDto } from '../common/dto/pagination.dto';
+import { ApiBody, ApiOperation, ApiQuery, ApiResponse, ApiTags } from '@nestjs/swagger';
+
+@Controller('stories')
+@ApiTags('stories')
+export class StoryController {
+  constructor(private readonly storyService: StoryService) {}
+
+  @Post()
+  @HttpCode(HttpStatus.CREATED)
+  @ApiOperation({ summary: '스토리 생성 API', description: '스토리를 생성합니다.' })
+  @ApiBody({ type: CreateStoryRequestDto })
+  @ApiResponse({ status: 201, description: '스토리 생성 성공' })
+  @ApiResponse({ status: 400, description: '잘못된 요청' })
+  async createStory(@Body() request: CreateStoryRequestDto) {
+    return await this.storyService.createStory(request);
+  }
+
+  @Get()
+  @HttpCode(HttpStatus.OK)
+  @ApiOperation({ summary: '스토리 목록 조회 API', description: '스토리 목록을 조회합니다.' })
+  @ApiQuery({ name: 'page', type: Number, required: false, description: '페이지 번호' })
+  @ApiQuery({ name: 'limit', type: Number, required: false, description: '페이지 크기' })
+  @ApiResponse({ status: 200, description: '스토리 목록 조회 성공' })
+  @ApiResponse({ status: 400, description: '잘못된 요청' })
+  async getStories(@Query() request: PaginationDto) {
+    return await this.storyService.getStories(request);
+  }
+
+}

src/story/story.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common';
+import { StoryService } from './story.service';
+import { StoryController } from './story.controller';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { Story } from './entities/story.entity';
+import { Hashtag } from '../hashtag/entity/hashtag.entity';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([Story, Hashtag])],
+  providers: [StoryService],
+  controllers: [StoryController],
+})
+export class StoryModule {}