인스타스토리 포스팅 및 조회 api

README.md

@@ -1,10 +1,11 @@
 # 미션 - 인스타 스토리 API
 
 ## 🎯 서버 세팅 방식
+
 - setup.sh 스크립트를 실행하여 서버를 세팅한다.
 - setup.sh 스크립트는 다음과 같은 작업을 수행한다.
-    - orm `typeorm, prisma`, 패키지 매니저 `npm, yarn, pnpm` 선택
-    - npm install | yarn | pnpm install 실행
+  - orm `typeorm, prisma`, 패키지 매니저 `npm, yarn, pnpm` 선택
+  - npm install | yarn | pnpm install 실행
 
 ```bash
 ./setup.sh
@@ -31,108 +32,124 @@ Ran all test suites.
 ---
 
 ## 🚀 기능 요구 사항
+
 인스타 스토리와 유사한 형태의 게시글을 위한 API를 구현한다.
 
 예시)
+
 1. 스토리를 생성한다.
 2. 12 or 24시간이내 스토리를 조회한다.
 
 총 2개의 API 엔드포인트로 구성한다.
-  - 스토리를 생성하는 API
-    - 프론트엔드 관점에서 스토리에는 `제목`, `이미지`, `해시태그`, `작성자 이름`이 포함되어 구성된어야한다. 
-    - 스토리를 생성할 때, 스토리의 유효기간 `12시간 | 24시간` 을 설정할 수 있다.
-    - `작성자 이름`의 경우, 현재 로그인한 유저의 이름을 가져온다고 가정한다.
-    - `해시태그`의 경우, `#`을 포함한 `문자열`로 구성되어야하고, 중복시 하나의 `해시태그`로 인식한다.
-    ```
-    예시) #어쩌다 #Nest와 #어쩌다 #스터디에서 #어쩌다는 같은 식별자를 가진 하나의 해시태그이다. 
-    ```
-
-  - 스토리를 조회하는 API 
-    - 스토리를 조회하는 시점으로부터 `12시간 | 24시간 이전` 에 생성된 스토리만 조회할 수 있다.
-    - 스토리 조회 시, `해시태그`의 정보를 함께 조회할 수 있다.
+
+- 스토리를 생성하는 API
+
+  - 프론트엔드 관점에서 스토리에는 `제목`, `이미지`, `해시태그`, `작성자 이름`이 포함되어 구성된어야한다.
+  - 스토리를 생성할 때, 스토리의 유효기간 `12시간 | 24시간` 을 설정할 수 있다.
+  - `작성자 이름`의 경우, 현재 로그인한 유저의 이름을 가져온다고 가정한다.
+  - `해시태그`의 경우, `#`을 포함한 `문자열`로 구성되어야하고, 중복시 하나의 `해시태그`로 인식한다.
+
+  ```
+  예시) #어쩌다 #Nest와 #어쩌다 #스터디에서 #어쩌다는 같은 식별자를 가진 하나의 해시태그이다.
+  ```
+
+- 스토리를 조회하는 API
+  - 스토리를 조회하는 시점으로부터 `12시간 | 24시간 이전` 에 생성된 스토리만 조회할 수 있다.
+  - 스토리 조회 시, `해시태그`의 정보를 함께 조회할 수 있다.
 
 ### 공통 필수 예외처리 사항
 
 - API에 요청받은 Body 값의 타입을 검증하여 올바르지 않은 타입일 경우 `400 BadRequest` 에러를 리턴해야한다.
 - API에 요청받은 Body 값의 필수 값이 누락되거나/빈 값인 경우 `400 BadRequest` 에러를 리턴해야한다.
 
-
 ### API 요청/응답 요구 사항
+
 1. 모든 API의 요청/응답은 DTO를 통해 TypeSafe하게 이루어져야한다.
 2. DTO의 타입은 `class-validator`를 이용하여 검증한다.
 3. DTO 내부 요소의 명칭은 `camelCase`로 작성한다.
 
 #### 요청
+
 - 유효기간은 `12시간 | 24시간`의 `number` 형식이다.
+
 ```
 validTime : 12 | 24
 ```
 
 - 제목은 `string` 형식이다.
+
 ```
 title : '어쩌다 Nest'
 ```
 
 - 작성자 이름은 `string` 형식이다.
+
 ```
 author : '어쩌다'
 ```
 
 - 이미지는 `url 형태의 문자열` 형식이다.
+
 ```
 image : https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D
 ```
 
 - 해시태그는 `#`을 포함한 문자열 리스트 형식이다.
+
 ```
 hashtags : [ '#어쩌다', '#Nest', '#당근' ]
 ```
 
 - 스토리 조회시 `Pagination`을 지원한다.
+
 ```
 page : 1
 limit : 10
 ```
 
 #### 응답
+
 - 정상적으로 스토리가 생성될 시 생성된 데이터를 리턴한다.
+
 ```json
 {
-  "id" : 1,
-  "createdAt" : "2023-11-21T12:00:00.000Z",
-  "validTime" : 24,
-  "title" : "어쩌다 Nest",
-  "author" : "어쩌다",
-  "image" : "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
-  "hashtags" : [ "#어쩌다", "#Nest", "#당근" ]
+  "id": 1,
+  "createdAt": "2023-11-21T12:00:00.000Z",
+  "validTime": 24,
+  "title": "어쩌다 Nest",
+  "author": "어쩌다",
+  "image": "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
+  "hashtags": ["#어쩌다", "#Nest", "#당근"]
 }
 ```
 
 - 정상적으로 스토리가 목록 조회될 시 조회된 데이터를 리턴한다.
+
 ```json
 {
-  "data" : [
+  "data": [
     {
-      "id" : 1,
-      "createdAt" : "2023-11-21T12:00:00.000Z",
-      "validTime" : 24,
-      "title" : "어쩌다 Nest",
-      "author" : "어쩌다",
-      "image" : "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
-      "hashtags" : [ "#어쩌다", "#Nest", "#당근" ]
-    },{
-      "id" : 2,
-      "createdAt" : "2023-11-23T12:00:00.000Z",
-      "validTime" : 12,
-      "title" : "NestJs",
-      "author" : "어쩌다가 팀장",
-      "image" : "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
-      "hashtags" : [ "#어쩌다", "#Nest", "#당근" ]
+      "id": 1,
+      "createdAt": "2023-11-21T12:00:00.000Z",
+      "validTime": 24,
+      "title": "어쩌다 Nest",
+      "author": "어쩌다",
+      "image": "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
+      "hashtags": ["#어쩌다", "#Nest", "#당근"]
+    },
+    {
+      "id": 2,
+      "createdAt": "2023-11-23T12:00:00.000Z",
+      "validTime": 12,
+      "title": "NestJs",
+      "author": "어쩌다가 팀장",
+      "image": "https://images.unsplash.com/photo-1533738363-b7f9aef128ce?q=80&w=1635&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
+      "hashtags": ["#어쩌다", "#Nest", "#당근"]
     }
   ],
-  "page" : 1,
-  "totalPage" : 1,
-  "limit" : 10
+  "page": 1,
+  "totalPage": 1,
+  "limit": 10
 }
 ```
 
@@ -146,11 +163,27 @@ limit : 10
 - **eslint**, **prettier** 등의 코드 포맷팅 라이브러리를 이용하여 제공된 코드 컨벤션에 맞추어 코드를 작성한다.
 - `node`, `npm` 버전은 `package.json`에 명시된 버전을 사용한다. [Volta를 이용하여 node 버전을 관리한다.](https://docs.volta.sh/guide/getting-started)
 
-
 - **(선택 사항)** API 구현이 완료되고, 유닛 테스트, E2E 테스트등 모든 테스트 코드를 작성하여 테스트를 통과하면 굿!
+
 ---
 
 ## ✏️ 과제 진행 요구 사항
 
 - 미션은 [nest-insta-story-2](https://github.com/eojjeoda-nest/nest-insta-story-2) 저장소를 Fork & Clone 하고 시작한다.
-- **기능을 구현하기 전 `README.md`에 구현할 기능/예외처리를 목록으로 정리**해 추가한다.
+- **기능을 구현하기 전 `README.md`에 구현할 기능/예외처리를 목록으로 정리**해 추가한다.
+
+# 구현 기능
+
+1. 스토리 생성 API
+
+- Prisma 세팅
+- DTO 셋팅
+- post 기능 구현
+
+2. 스토리 조회 API
+
+- 페이지 네이션
+
+# 예외 처리
+
+1.정상적인 입력 검증(DTO 형식 검증, 빈 데이터 검증) - class-validator

src/app.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { PrismaService } from './prisma/prisma.service';
+import { StoryModule } from './story/story.module';
+
+@Module({
+  imports: [ConfigModule.forRoot({ isGlobal: true }), StoryModule],
+  providers: [PrismaService],
+  exports: [PrismaService],
+})
+export class AppModule {}

src/prisma/migrations/20241025062047_insta/migration.sql

@@ -0,0 +1,12 @@
+-- CreateTable
+CREATE TABLE `Story` (
+    `id` INTEGER NOT NULL AUTO_INCREMENT,
+    `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
+    `validTime` INTEGER NOT NULL,
+    `title` VARCHAR(191) NOT NULL,
+    `author` VARCHAR(191) NOT NULL,
+    `image` VARCHAR(191) NOT NULL,
+    `hashtags` JSON NOT NULL,
+
+    PRIMARY KEY (`id`)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

src/prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "mysql"

src/prisma/prisma.module.ts

@@ -0,0 +1,9 @@
+// src/prisma/prisma.module.ts
+import { Module } from '@nestjs/common';
+import { PrismaService } from './prisma.service';
+
+@Module({
+  providers: [PrismaService],
+  exports: [PrismaService],
+})
+export class PrismaModule {}

template/source/prisma-src/prisma/schema.prisma → src/prisma/schema.prisma

@@ -7,17 +7,15 @@ generator client {
 datasource db {
   provider          = "mysql"
   url               = env("DATABASE_URL")
-  shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
+  // shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
 }
 
-// 유저 테이블
-model User {
+model Story {
   id          Int       @id @default(autoincrement())
   createdAt   DateTime  @default(now())
-  updatedAt   DateTime  @default(now()) @updatedAt
-  name        String
-  phoneNumber String // 전화번호
-  adminMemo   String?
-  isDeleted   Boolean   @default(false) // 삭제 여부
-  deletedAt   DateTime? // 회원 탈퇴일
+  validTime   Int
+  title       String
+  author      String
+  image       String
+  hashtags    Json
 }

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

@@ -0,0 +1,30 @@
+import {
+  ArrayNotEmpty,
+  IsArray,
+  IsNotEmpty,
+  IsNumber,
+  IsString,
+} from 'class-validator';
+
+export class CreateStoryDto {
+  @IsNumber()
+  @IsNotEmpty()
+  validTime: number;
+
+  @IsString()
+  @IsNotEmpty()
+  title: string;
+
+  @IsString()
+  @IsNotEmpty()
+  author: string;
+
+  @IsString()
+  @IsNotEmpty()
+  image: string;
+
+  @IsArray()
+  @ArrayNotEmpty()
+  @IsString({ each: true })
+  hashtags: string[];
+}

src/story/dto/get-stroy.dto.ts

@@ -0,0 +1,11 @@
+import { IsNotEmpty, IsNumber } from 'class-validator';
+
+export class GetStroyDto {
+  @IsNumber()
+  @IsNotEmpty()
+  page: number;
+
+  @IsNumber()
+  @IsNotEmpty()
+  limit: number;
+}

src/story/entities/story.entity.ts

@@ -0,0 +1 @@
+export class Story {}

src/story/story.controller.spec.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { StoryController } from './story.controller';
+import { StoryService } from './story.service';
+
+describe('StoryController', () => {
+  let controller: StoryController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [StoryController],
+      providers: [StoryService],
+    }).compile();
+
+    controller = module.get<StoryController>(StoryController);
+  });
+
+  it('should be defined', () => {
+    expect(controller).toBeDefined();
+  });
+});

src/story/story.controller.ts

@@ -0,0 +1,19 @@
+import { Controller, Get, Post, Body } from '@nestjs/common';
+import { StoryService } from './story.service';
+import { CreateStoryDto } from './dto/create-story.dto';
+import { GetStroyDto } from './dto/get-stroy.dto';
+
+@Controller('story')
+export class StoryController {
+  constructor(private readonly storyService: StoryService) {}
+
+  @Post()
+  create(@Body() createStoryDto: CreateStoryDto) {
+    return this.storyService.create(createStoryDto);
+  }
+
+  @Get()
+  findAll(@Body() getStroyDto: GetStroyDto) {
+    return this.storyService.findAll(getStroyDto);
+  }
+}

src/story/story.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { StoryService } from './story.service';
+import { StoryController } from './story.controller';
+import { PrismaModule } from 'src/prisma/prisma.module';
+
+@Module({
+  imports: [PrismaModule],
+  controllers: [StoryController],
+  providers: [StoryService],
+})
+export class StoryModule {}

src/story/story.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { StoryService } from './story.service';
+
+describe('StoryService', () => {
+  let service: StoryService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [StoryService],
+    }).compile();
+
+    service = module.get<StoryService>(StoryService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});