Skip to content

Latest commit

 

History

History
123 lines (112 loc) · 5.33 KB

README.md

File metadata and controls

123 lines (112 loc) · 5.33 KB
Raw

Team-C payhere

프로젝트 진행 기간 2022.07.04 ~ 2022.07.08

환경

node npm mysql docker

서비스 개요

본인의 소비내역을 기록/관리할 수 있는 서비스

요구사항 분석

  • 고객은 이메일과 비밀번호 입력을 통해서 회원 가입할 수 있다
  • 고객은 로그인과 로그아웃을 할 수 있다
  • 로그인 상태가 아니면 가계부 내역에 대한 접근 제한 처리가 되어야 한다
  • 고객은 로그인 이후 가계부 관련 아래의 행동을 할 수 있다
    • 가계부에 오늘 사용한 돈의 금액과 관련된 메모를 남길 수 있다
    • 가계부에서 수정을 원하는 내역은 금액과 메모를 수정할 수 있다
    • 가계부에서 삭제를 원하는 내역은 삭제할 수 있다
    • 삭제한 내역은 언제든지 다시 복구할 수 있다
    • 가계부에 기록한 가계부 리스트를 볼 수 있다
    • 가계부에서 상세한 세부 내역을 볼 수 있다

API Documentation

https://documenter.getpostman.com/view/21440012/UzJMrFXk

DB Modeling

ERD

프로젝트 담당 역할

김지유

    • 맡은 부분 README.md 작성
    • Api Documentation
    • Docker
    • DB 모델링
    • 타입 검증 미들웨어
    • 가계부 CRUD
      • 가계부 기록 등록
      • 가계부 기록 수정
      • 가계부 기록 삭제
      • 가계부 기록 복구
      • 가계부 기록 리스트
      • 가계부 기록 상세 내역

김영우

    • README.md 작성
    • 접근 제한 처리
    • 토큰 인증 제어
    • 프로젝트 초기화, lint, formatting
    • 사용자 API
      • 회원가입
      • 로그인

공통

    • 테스트 케이스(일부만 구현)

구현 과정

김지유

  • 타입 검증 미들웨어
    • 사용자, 가계부 API 사용 시, req.body 가 안전한 형식임을 검증할 필요가 있었음.
    • 타입 검증은 비즈니스 로직의 역할이 아니라 생각하여 API 이전 미들웨어로 분리.
  • 가계부 API
    • 토큰 검증, 타입 검증을 거쳐 비즈니스 로직만을 수행함.
    • Rest API 의 HATEOAS 개념을 나름 살려보기 위해 간단하게 Location 헤더를 사용했다.
    • 시간이 부족해 Location 헤더를 사용했지만, 추후 시간이 된다면 HAL 을 적용시켜 보고 싶다.
      • 가계부 기록 등록 - 생성된 데이터, 201 Created 와 함께 Location 헤더에 생성된 데이터에 접근 가능한 URL 을 담아 응답한다.
      • 가계부 기록 수정 - 수정된 가계부 기록 Id, 수정된 내용, 200 OK 와 함께 Location 헤더에 수정된 데이터에 접근 가능한 URL 을 담아 응답한다.
      • 가계부 기록 삭제 - 204 No Content 와 함께 Location 헤더에 복구를 위한 URL 을 담아 응답한다.
      • 가계부 기록 복구 - 복구된 데이터, 데이터가 삭제됐던 일시, 200 OK 와 함께 복구된 데이터에 접근 가능한 URL 을 담아 응답한다.
      • 가계부 기록 리스트 - 200 OK 와 함께 가계부 기록 리스트를 응답한다.
      • 가계부 기록 상세 내역 - 200 OK 와 함께 가계부 상세 내역을 응답한다.

김영우

  • 사용자 API
    • 회원가입 - 요청한 이메일로 이메일 조회 후 없으면 비밀번호 hash 후 DB 등록
    • 로그인 - 요청한 이메일로 이메일 조회 후 hash된 비밀번호와 요청 비밀번호 비교, 일치하면 토큰 발급 및 전달
    • 로그아웃 - 따로 구현하지 않고 클라이언트에서 처리하는걸로 결정
  • 토큰 발급, 검증 및 접근 제한
    • 접근 제한 - 가계부 API 요청 전 토큰 검증하는 미들웨어에서 확인하고 가계부 처리 / 토큰 이상 시 에러
    • 발금, 검증 - jsonwebtoken 라이브러리 사용하여 발급 및 검증 구현
    • 재발급 - access 토큰 만료 시 재요청, refresh 검증 및 DB 토큰과 비교, 일치하면 토큰 발급 및 전달

구동 방법

환경변수 설정

.env 파일에 아래의 값 필요

SALT_ROUNDS=SALT 값(10 이상)
JWT_ALGORITHM=해쉬 알고리즘 값(ex. HS512, RS512)
JWT_ACCESS_SECRET_KEY=access token base64 encoded 개인 키 값
JWT_REFRESH_SECRET_KEY=refresh token base64 encoded 개인 키 값
JWT_ACCESS_EXPIRESIN=access token 만료 시간(ex. 30m(30분))
JWT_REFRESH_EXPIRESIN=refresh token 만료 시간(ex. 14d(14일))
MYSQL_ROOT_PASSWORD=team-c/payhere
MYSQL_USER=team-c
MYSQL_PASSWORD=team-c/payhere
MYSQL_DATABASE=nodejs_prod
MYSQL_HOSTNAME=mysql
MYSQL_PORT=3306

설치하기

$ git clone https://github.com/pre-onboarding-team-c/02-C-Payhere.git
$ cd 02-C-Payhere
$ npm install

실행하기

$ npm run start:prod

Docker 실행하기

$ (sudo) docker-compose build
$ (sudo) docker-compose up -d

Docker 종료하기

$ (sudo) docker-compose down

테스트 실행하기

$ npm test