kim-jos/12-punch-assignment2-freshcode

[Assignment 2] 프레시코드

원티드x위코드 백엔드 프리온보딩 과제2

• 과제 출제 기업 정보
  • 기업명 : 프레시코드
  • 프레시코드 사이트
  • wanted 채용공고 링크

Members

이름	github	담당 기능
김남형	42seouler	Unit Testing
김서경	riley909	Deployment
김요셉	kim-jos	회원가입, 로그인, user CRUD
정천우	codehousepig	Menu, Item, Tag CRUD, DB Modeling
최유진	n12seconds	DB Modeling, postman api 작성

과제 내용

아래 요구사항에 맞춰 게시판 Restful API를 개발합니다.

• 주어진 요구사항에 대한 설계/구현 능력
• 코드로 동료를 배려할 수 있는 구성 능력 (코드, 주석, README 등)
• 유닛 테스트 구현 능력

[필수 포함 사항]

• Swagger나 Postman을 이용하여 API 테스트 가능하도록 구현
  • Swagger 대신 Postman 이용시 API 목록을 Export하여 함께 제출해 주세요
• READ.ME 작성
  • 프로젝트 빌드, 자세한 실행 방법 명시
  • 구현 방법과 이유에 대한 간략한 설명
  • 완료된 시스템이 배포된 서버의 주소
  • Swagger를 통한 API 테스트할때 필요한 상세 방법
  • 해당 과제를 진행하면서 회고 내용 블로그 포스팅

[개발 요구사항]

• 로그인 기능
  • JWT 인증 방식을 구현합니다.
• Database 는 RDBMS를 이용합니다.

사용 기술 및 tools

• Back-End :
• Deploy :
• ETC :   

DB Schema

AWS Architecture

API

링크-postman document

구현 기능

회원가입, 로그인

• 회원가입시 password 같은 민감정보는 해쉬 알고리즘인 bcrypt를 사용해 암호화 하여 database에 저장했습니다
• 로그인이 성공적으로 완료되면 JWT 토큰이 반환됩니다

상품 CRUD

• 조회는 누구나 가능하며, 로그인 이후(header에 token이 있는 상태) 권한을 검사하여 관리자("role":"admin")는 상품 추가/수정/삭제를 할 수 있습니다.
• pagination이 가능하도록 구현하였습니다. 기본 상품 조회 수는 5개이며, limit=상품개수 로 한 페이지당 조회되는 개수를 조절할 수 있습니다.
• 상품 등록시 ValidationPipe() 를 이용하여 forbidNonWhitelisted: true 옵션으로 entity 의 없는 값을 사전에 차단합니다.

아이템, 태그 CRUD

• Item, Tag 각각 조회는 가능하지만, 추가/수정/삭제는 관리자만이 할 수 있습니다.
• Menu 와 @ManyToOne 으로 관계를 맺고 있어 따로 조회를 하지 않아도 해당 메뉴와 같이 조회됩니다.
• 연관된 Menu 삭제 시 onDelete: 'CASCADE' 옵션으로 같이 삭제됩니다.

API TEST 방법

1. 다음 링크로 이동합니다. postman 링크
2. user폴더 안의 회원가입, 로그인 요청을 통하여 accessToken을 획득합니다.
3. 권한이 필요한 api 요청 시 header의 Authorization 항목에 accessToken을 입력하여 요청할 수 있습니다.

• menus, items, tag 폴더의 api는 관리자만 전체 요청 가능하고 일반 회원은 리스트 조회와 단건 조회만 가능합니다.
• 로그인, 회원가입을 제외한 user폴더 내의 api는 테스트 용도로, 별도의 접근 권한 제한을 두지 않았습니다.

설치 및 실행 방법

Installation

$ npm install

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

테스팅 방법

# unit tests
$ npm run test

TIL정리 (Blog)

• 김남형 : controller-unit-test
• 김서경 : 프레시코드 기술과제 회고
• 김요셉 : Authentication & Authorization
• 정천우 : codehousepig
• 최유진 : become-clear

Reference

이 프로젝트는 원티드x위코드 백엔드 프리온보딩 과제 일환으로 FRESHCODE에서 출제한 과제를 기반으로 만들었습니다.