/Assignment4

원티드x위코드 백엔드 프리온보딩 프로젝트 #4 : 8퍼센트

Primary LanguagePython

원티드x위코드 백엔드 프리온보딩 프로젝트 #4

해당 프로젝트는 원티드X위코드 프리온보딩 백엔드 코스에서 수행한 8퍼센트의 기업 과제 입니다.

✔️Members

이름 github 담당 기능
박세원 sw-develop 거래 내역 조회 API 구현, 거래 내역 조회 시 입금/출금 & 거래일시에 대한 필터링 및 Cursor Pagination 적용, 입금/출금/거래내역조회에 대한 Functional Test 코드 작성

✔️구현 조건 내용

구현 조건 자세히 보기

[필수 포함 사항]

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

📝 “계좌 거래 API”를 구현해주세요. API는 3가지가 구현되어야 합니다.

✔️ API 목록

  • 거래내역 조회 API
  • 입금 API
  • 출금 API

✔️ 주요 고려 사항은 다음과 같습니다.

  • 계좌의 잔액을 별도로 관리해야 하며, 계좌의 잔액과 거래내역의 잔액의 무결성의 보장
  • DB를 설계 할때 각 칼럼의 타입과 제약

✔️ 구현하지 않아도 되는 부분은 다음과 같습니다.

  • 문제와 관련되지 않은 부가적인 정보. 예를 들어 사용자 테이블의 이메일, 주소, 성별 등
  • 프론트앤드 관련 부분

✔️ 제약사항은 다음과 같습니다.

  • (8퍼센트가 직접 로컬에서 실행하여 테스트를 원하는 경우를 위해) 테스트의 편의성을 위해 mysql, postgresql 대신 sqllite를 사용해 주세요.

✔️ 상세설명 1) 거래내역 조회 API

  • 아래와 같은 조회 화면에서 사용되는 API를 고려하시면 됩니다.

거래내역 API는 다음을 만족해야 합니다.

  • 계좌의 소유주만 요청 할 수 있어야 합니다.
  • 거래일시에 대한 필터링이 가능해야 합니다.
  • 출금, 입금만 선택해서 필터링을 할 수 있어야 합니다.
  • Pagination이 필요 합니다.
  • 다음 사항이 응답에 포함되어야 합니다.
    • 거래일시
    • 거래금액
    • 잔액
    • 거래종류 (출금/입금)
    • 적요

2) 입금 API

입금 API는 다음을 만족해야 합니다.

  • 계좌의 소유주만 요청 할 수 있어야 합니다.

3) 출금 API 출금 API는 다음을 만족해야 합니다.

  • 계좌의 소유주만 요청 할 수 있어야 합니다.
  • 계좌의 잔액내에서만 출금 할 수 있어야 합니다. 잔액을 넘어선 출금 요청에 대해서는 적절한 에러처리가 되어야 합니다.

4) 가산점 다음의 경우 가산점이 있습니다.

  • Unit test의 구현
  • Functional Test 의 구현 (입금, 조회, 출금에 대한 시나리오 테스트)
  • 거래내역이 1억건을 넘어갈 때에 대한 고려
    • 이를 고려하여 어떤 설계를 추가하셨는지를 README에 남겨 주세요.

✔️사용 기술 및 tools

  • Back-End :    
  • Deploy :  
  • ETC :    

✔️모델링

image

  • 계좌잔액, 거래내역의 금액 관련 필드들 일반 IntegerField 대신, PositiveBigIntegerField를 사용하였습니다.
  • IntegerField는 약 21억까지 저장되기 때문에, 계좌 잔액을 나타내기가 부족하다고 판단했습니다. BigIntegerField로 할 시, 약 900경까지 표현할 수 있습니다.

✔️API

링크-Swagger

✔️구현 기능

거래 내역 조회 API

  • 계좌의 소유주만 거래 내역 조회 가능
  • 입금, 출금만 선택해서 필터링
  • 거래일시별로 조회기간을 정해서 필터링 및 Cursor Pagination 적용

✔️Functional Test 의 구현 시나리오

  • Functional Test는 E2E(End-to-End) 혹은 브라우저 테스트로 소프트웨어 내부 구조나 구현 방법을 고려하기보다 테스트 시나리오를 바탕으로 실제 사용자가 접하는 브라우저 테스트를 하는 것입니다.
  • 하지만 현재 프로젝트는 프론트 부분을 구현하지 않았으므로 해당 방향으로 테스트를 진행하기는 어렵다고 판단하였습니다.
  • 대신 사용자의 입장에서 구현한 기능(회원가입/로그인/계좌 및 거래 관련)들의 일련의 시나리오를 각각 구성하여 테스트를 진행하였으며, 핵심 기능인 입금, 출금, 거래 내역 조회 시나리오는 다음과 같습니다.

입금 시나리오

  • 사용자 로그인 → 계좌 생성 → 입금 → 입금 거래 내역 조회 에 대한 테스트 시나리오를 작성 하였고, 현재 계좌의 잔액과 마지막 입금 내역의 잔액이 동일함을 확인하여 테스트를 통과하였다. (테스트 시나리오에서 진행한 입금이 마지막 거래 내역이라고 가정)

출금 시나리오

  • 로그인 → 출금 → 출금 거래 내역 조회 에 대한 테스트 시나리오를 작성하였고, 현재 계좌의 잔액과 마지막 출금 내역의 잔액이 동일함을 확인하여 테스트를 통과하였다. (테스트 시나리오에서 진행한 출금이 마지막 거래 내역이라고 가정)

거래 내역 조회 시나리오

  • 로그인 → 입금/출금 내역 생성 → 거래 내역 조회 에 대한 테스트 시나리오를 작성하였고, 생성한 거래 내역(2개)을 기반으로 ‘조회 기간‘이 오늘이고, ‘최근 거래 내역이 위로’인 경우에 대한 응답으로 온 거래 내역 데이터가 총 2개이고, 현재 계좌의 잔액과 마지막 거래 내역의 잔액이 동일함을 확인하여 테스트를 통과합니다.

위의 시나리오를 test_functional_test.py에 구현하였습니다.

✔️배포정보

구분 정보 비고
배포플랫폼 AWS EC2
API 주소 http://18.188.189.173:8031/

✔️API TEST 방법

  1. 우측 링크를 클릭해서 swagger로 들어갑니다. 링크

  2. 회원가입을 진행합니다. (email, name, password 필드만 입력) image

  3. 가입된 정보를 이용해서 로그인을 합니다. (email, password 필드만 입력) image

  4. 로그인 시 획득한 access key를 이용해서 다른 api에 적용합니다. image

다른 api의 Authorization 항목에 Token access_key 를 입력합니다. image

✔️설치 및 실행 방법

Local 개발 및 테스트용

Local 개발 및 테스트용

  1. 해당프로젝트를 clone 하고, 프로젝트 폴더로 들어간다.

    git clone https://github.com/Wanted-Preonboarding-Backend-1st-G5/Assignment4
cd Assignment4

  2. 가상 환경을 만들고 프로젝트에 사용한 python package를 받는다.

    conda create --name Assignment4 python=3.8
conda actvate Assignment4
pip install -r requirements.txt

  3. Django SECRET_KEY용 환경 변수를 등록한다.

       export DJANGO_SECRET_KEY='django시크릿키'

  4. db를 table 구조를 최신 model에 맞게 설정한다.

    python manage.py migrate

  5. 서버를 실행한다.

    python manage.py runserver 0.0.0.0:8000
배포용

배포용

  1. 해당프로젝트를 clone 하고, 프로젝트 폴더로 들어간다.

    git clone https://github.com/Wanted-Preonboarding-Backend-1st-G5/Assignment4
cd Assignment4

  2. docker환경 설정 파일을 만든다.

  3. 백엔드 서버용 .dockerenv.deploy.backend 파일을 만들어서 안에 다음과 같은 내용을 입력한다. manage.py와 같은 폴더에 생성한다.

    .dockerenv.deploy.backend

      DJANGO_SECRET_KEY='django시크릿키'

  4. docker-compose를 통해서 db와 서버를 실행시킨다.

    docker-compose -f docker-compose-deploy.yml up

  5. 만약 백그라운드에서 실행하고 싶을 시 -d 옵션을 추가한다.

    docker-compose -f docker-compose-deploy.yml up -d

✔️폴더 구조

📦Assignment4
 ┣ 📂accounts
 ┃ ┣ 📂migrations
 ┃ ┣ 📂tests
 ┃ ┃ ┣ 📜__init__.py
 ┃ ┃ ┣ 📜tests_account.py
 ┃ ┃ ┣ 📜tests_deposit.py
 ┃ ┃ ┣ 📜tests_tradelog.py
 ┃ ┃ ┗ 📜tests_withdrawal.py
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜admin.py
 ┃ ┣ 📜apps.py
 ┃ ┣ 📜exceptions.py
 ┃ ┣ 📜filters.py
 ┃ ┣ 📜managers.py
 ┃ ┣ 📜models.py
 ┃ ┣ 📜permissions.py
 ┃ ┣ 📜serializers.py
 ┃ ┣ 📜urls.py
 ┃ ┗ 📜views.py
 ┣ 📂config
 ┃ ┗ 📂nginx
 ┃ ┃ ┗ 📜nginx.conf
 ┣ 📂eight_percent
 ┃ ┣ 📂settings
 ┃ ┃ ┣ 📜__init__.py
 ┃ ┃ ┣ 📜base.py
 ┃ ┃ ┣ 📜deploy.py
 ┃ ┃ ┣ 📜dev_local.py
 ┃ ┃ ┗ 📜dev_local_dblog.py
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜asgi.py
 ┃ ┣ 📜urls.py
 ┃ ┗ 📜wsgi.py
 ┣ 📂users
 ┃ ┣ 📂migrations
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜admin.py
 ┃ ┣ 📜apps.py
 ┃ ┣ 📜models.py
 ┃ ┣ 📜permissions.py
 ┃ ┣ 📜serializers.py
 ┃ ┣ 📜tests.py
 ┃ ┣ 📜urls.py
 ┃ ┗ 📜views.py
 ┣ 📜docker-compose-depoly.yml
 ┣ 📜README.md
 ┣ 📜manage.py
 ┣ 📜pull_request_template.md
 ┣ 📜requirements.txt
 ┗ 📜test_functional_test.py

Reference

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