[230424]

🍎 Target

💡 장고 심화 강의를 들은 캠퍼

🍎 Goal

💡 DRF 단단히 하기! 1. 기본적인 데이터 처리 기능인 CRUD 익숙해지기 2. DRF 모델 쿼리셋에 익숙해지기 3. DRF 시리얼라이저에 익숙해지기

🥕 Todo List를 DRF로 만들어보기

🍏 목표

• ERD 툴을 사용해 User, Todo 테이블 설계하기
  

• postman으로 테스트 할 수 있는 API로 구성된 Todo List 프로젝트 만들기
  (현 과제는 기능적인 숙달을 목표로 하기 때문에 프론트는 만들지 않아도 됩니다.)

🍏 필수 사용 기술

• djangorestframework 시리얼라이저, 모델 쿼리셋 사용

🍏 상세 요구사항

• 회원 기능
  1. 사용자가 회원가입을 할 수 있어야 합니다.
     • 사용자 테이블(User) 필수 필드
       1. id : 데이터 고유 id 입니다(PK).
       2. email : 아이디로 사용되며 유니크한 값입니다.
       3. password : 비밀번호로 사용되며 회원 생성, 수정 시 암호화(해시)된 값을 저장해야 합니다.
       4. name : 사용자의 이름입니다.
       5. gender : 사용자의 성별입니다.
       6. age : 사용자의 나이입니다.
       7. introduction : 사용자의 자기소개 글 입니다.
     • POST 요청 시 회원가입이 되어야 합니다.
  2. 사용자가 로그인을 할 수 있어야 합니다.
     • POST 요청 시 장고 세션 기능을 이용해 로그인이 되어야 합니다.
     • 세션 기반의 인증이 익숙하다면 JWT기반 인증으로 구현해보는 것도 괜찮습니다.
  3. 사용자가 로그아웃을 할 수 있어야 합니다.
     • POST 요청 시 세션 정보를 삭제해 로그아웃이 되어야 합니다.
  4. 사용자가 회원 정보를 수정할 수 있어야 합니다.
     • PUT 요청 시 아이디를 제외한 모든 회원 정보를 수정할 수 있어야 합니다.
     • 비밀번호 수정 시 암호화된 값을 저장해야 합니다.
  5. 사용자가 회원 탈퇴를 할 수 있어야 합니다.
     • DELETE 요청 시 계정을 삭제합니다(탈퇴).

---

• TODO LIST 기능

  1. 사용자가 할일(Todo)을 만들 수 있어야 합니다.

     • 할일 테이블(Todo) 필수 필드
       1. id : 데이터 고유 id 입니다(PK).
       2. title : 할일 제목입니다.
       3. is_complete : 완료 여부입니다. 데이터 타입은 boolean이며 default false 설정을 합니다.
       4. created_at : 할일 생성 시간입니다.
       5. updated_at : 할일의 마지막 수정 시간입니다.
       6. completion_at : 할일 완료 시간입니다.
       7. user_id : 사용자 테이블과 FK로 관계형성이 되어야합니다.
     • POST 요청 시 할일이 생성되어야 합니다.

  2. 사용자가 할일 목록(Todo list)을 조회할 수 있어야합니다.

     • GET 요청 시 할일 목록을 조회할 수 있어야합니다.
     • response 예시

     [
         {
             "id": 1,
             "title": "과제하기",
             "is_complete": "True",
             "created_at": "2023-04-01",
             "updated_at": "",
             "completion_at": "2023-04-05",
         },
         {
             "id": 2,
             "title": "공부하기",
             "is_complete": "False",
             "created_at": "2023-04-02",
             "updated_at": "2023-04-03",
             "completion_at": ""
         },
         ...
     ]

  3. 사용자가 할일(Todo)을 수정할 수 있어야합니다.

     • PUT요청 시 할일 정보를 수정할 수 있어야합니다.
     • 할일을 완료한 경우 is_complete를 True로 수정할 수 있어야합니다.
       완료하지 않은 경우 False로 다시 수정할 수 있어야합니다.
     • 제목(title)을 수정할 수 있어야합니다.

  4. 사용자가 할일(Todo)을 삭제할 수 있어야합니다.

     • DELETE 요청 시 할일을 삭제합니다.
• response 예시가 없는 경우는 지금까지 배운 내용을 가지고 자유롭게 response를 만들어봅시다.
  • status_code
  • message
  • 데이터
    ex) 회원가입 시 가입한 유저정보

---

🍏추가요구사항

• 추가 요구사항 (권한) - option1

  💡 기본 요구사항을 충분히 구현했는데 시간이 남는다면 추가 요구사항을 개발해보아요!

  본인이 작성자가 아님에도 다른사람의 기록을 조회, 수정, 삭제할 수 있다면 개인정보 유출, 해킹 등의 이슈가 생길 수있습니다

  앞서 만든 기능에 작성자 본인만 조회, 수정, 삭제할 수 있도록 권한 기능을 개발해봅시다.

  • 다음 기능에 권한을 넣어 작성자 본인만 조회, 수정, 삭제할 수 있어야합니다.
    1. 회원 정보 : 수정, 삭제
    2. 할일 정보 : 조회, 수정, 삭제

---

• 추가 요구사항 (JWT 기반 인증) - option2

  💡 기본 요구사항을 충분히 구현했는데 시간이 남는다면 추가 요구사항을 개발해보아요!

  지금까지 쿠키를 사용하는 세션 방식 로그인을 구현했다면 이번엔 토큰을 사용하는 JWT 방식으로 access 토큰과 refresh 토큰을 발급받아봅시다.

  djangorestframework_simplejwt 라이브러리 사용을 권장 합니다.

  1. 사용자가 로그인을 할 수 있어야 합니다.

     1. POST 요청 시(로그인) 리턴 값으로 jwt refresh, access 토큰을 받을 수 있어야 합니다.
     2. access 토큰의 payload에는 사용자의 email, name, gender, age 정보가 담겨있어야 합니다.
     3. response 예시

     {
     	"refresh": "eyFDFJJagGENHA5I1NiIsdsfFD9POkpXVCD5.dAJzSsdfFD55xMjEENTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWIjoxFDPIELCOIDIyfQ.dFD44wRJSMDS454T4fasdfMeJf646dsfsDFFDDS54fe4",
     	"access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
     }

---

🍏 참고자료

• Django 공식문서
  Django
• DRF 공식문서
  Home - Django REST framework
• Django session 공식문서 예시
  Home - Django REST framework
  Simple JWT — Simple JWT 5.2.2.post16+gf298efa documentation