Giters

LazyerIJ / Django_rest_example

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Django_rest_example

1. Environment

  • docker

  • docker-compose

  • python 3.7

2. Run Project

  • Download Code
$git clone https://github.com/LazyerIJ/Django_rest_example
  • Django_rest_example/ablyproject/config/deploy/config.json 파일 설정
    • ACCESS_TYPE 이 "dev"일 경우 인증문자는 "0000"으로 고정됩니다.
{
    "ACCESS_TYPE": "service",
    "CONFIG_PATH": "logs"
}
  • Django_rest_example/ablyproject/config/deploy/secret.json 파일 설정 (Use NaverCloudPlatform)
{
    "phone_number": "",
    "access_key": "",
    "service_id": "",
    "secret_key": ""
}
  1. Run with docker
$cd Django_rest_example/ablyproject/
$docker-compose up -d

데이터베이스 스키마 build를 위한 migration 수행

docker-compose run --rm --entrypoint python app manage.py migrate
  1. Run from code
$cd Django_rest_example
$python -m pip install -r requirements.txt
$cd ablyproject
$python manage.py migrate
$python manage.py runserver
$python manage.py test tests

3. Project explanation

  • 모든 입출력은 REST API를 이용한 JSON 데이터로 이루어집니다.
  • 회원가입 / 문자인증 / 로그인 / 로그아웃 / 비밀번호 재설정 / 정보확인 기능으로 이루어져 있습니다.
    • 회원가입
      • POST [phone_number, nick_name, name, email, password]
      • /api/signup/
    • 비밀번호 재설정
      • UPDATE [phone_number, password]
      • /api/signup
    • 로그인
      • POST [phone_number, password]
      • /api/login/
    • 로그아웃
      • POST [phone_number, password]
      • /api/logout/
    • 문자인증
      • POST [phone_number, auth_number]
      • /api/auth/
    • 정보확인
      • GET [phone_number]
      • /api/user/

4. Project Todo List

  • 이메일 인증 및 이메일 로그인 구현
  • 관리자 사용자 (권한 지정 및 사용자 확인) 구현

5. CURL Example

  1. 회원가입 (POST. /api/signup/)

    {
    "phone_number": "01012341234",
    "password": "1234",
    "email": "ablyproject@gmail.com",
    "nickname": "lazyer",
    "name": "KimInJu"
}
    curl --location \
                --request POST "http://127.0.0.1:8000/api/signup/" \
                --header "Content-Type: application/json" \
                --data-raw "{
                \"phone_number\": \"01012341234\",
                \"password\": \"1234\",
                \"email\": \"ablyproject@gmail.com\",
                \"nickname\": \"lazyer\",
                \"name\": \"123\"
                }

  2. 문자인증 (POST. /api/auth/)

    {
    "phone_number": "01012341234",
    "auth_number": "0000"
}
    curl --location --request POST "http://127.0.0.1:8000/api/auth/" \
                --header "Content-Type: application/json" \
                --data-raw "{
                \"phone_number\": \"01012341234\",
                \"auth_number\": \"0000\"
                }

  3. 로그인 (POST. /api/login/)

    {
    "phone_number": "01012341234",
    "password": "1234"
}

    curl --location \
                --request POST "http://127.0.0.1:8000/api/login/" \
                --header "Content-Type: application/json" \
                --data-raw "{
                \"phone_number\": \"01012341234\",
                \"password\": \"4321\"
                }"

  4. 정보확인 (GET. /api/user/)

    curl --location \
            --request GET "http://127.0.0.1:8000/api/user?phone_number=01012341234" \
            --data-raw "

  5. 로그아웃 (POST. /api/logout/)

    {
    "phone_number": "01012341234",
    "password": "1234"
}

    curl --location \
                --request POST "http://127.0.0.1:8000/api/logout/" \
                --header "Content-Type: application/json" \
                --data-raw "{
                \"phone_number\": \"01012341234\",
                \"password\": \"1234\"
                }"

6. Test code

  • ablyproject/tests/test_api.py 에 테스트 코드가 작성되어 있으며 몇개의 시나리오 테스트가 있습니다.

  • 테스트를 위하여 인증문자를 "0000"으로 고정하기 위하여 Django_rest_example/ablyproject/config/deploy/config.json 의 ACCESS_TYPE을 아래와 같이 "dev"로 고정해주세요

    {
    "ACCESS_TYPE": "dev",
    "LOG_PATH": "logs"
}

테스트 코드는 아래 명령어로 실행 가능합니다.

$python manage.py test tests

[*]Scenario
        1. 로그인 -> 회원가입을 하지 않았기 때문에 오류 발생
        2. 정보 확인 -> 로그인을 하지 않았기 때문에 오류 발생

>>do_user_login:  400 존재하지 않는 사용자입니다.
>>do_user_info_get:  400 존재하지 않는 사용자입니다.
.
[*]Scenario
        1. 회원가입
        2. 문자인증
        3. 로그인
        4. 정보확인

>>do_user_signup:  200 SMS 인증문자 발송에 성공하였습니다.
>>do_user_auth:  200 SMS 문자인증에 성공하였습니다.
>>do_user_login:  200 로그인에 성공하였습니다.
>>do_user_info_get:  201 요청하신 작업이 정상수행 되었습니다.
.
[*]Scenario
        1. 회원가입
        2. 문자인증
        3. 로그인
        4. 로그인 -> 이미 로그인 하였으므로 오류발생

>>do_user_signup:  200 SMS 인증문자 발송에 성공하였습니다.
>>do_user_auth:  200 SMS 문자인증에 성공하였습니다.
>>do_user_login:  200 로그인에 성공하였습니다.
>>do_user_login:  400 이미 로그인되어 있습니다.
.
[*]Scenario
        1. 회원가입
        2. 문자인증
        3. 로그인
        4. 로그아웃
        5. 로그아웃 -> 이미 로그아웃 하였으므로 오류발생

>>do_user_signup:  200 SMS 인증문자 발송에 성공하였습니다.
>>do_user_auth:  200 SMS 문자인증에 성공하였습니다.
>>do_user_login:  200 로그인에 성공하였습니다.
>>do_user_logout:  200 로그아웃에 성공하였습니다.
>>do_user_logout:  400 이미 로그아웃되어 있습니다.
.
[*]Scenario
        1. 회원가입
        2. 문자인증
        3. 로그인(잘못된 패스워드) -> 패스워드가 틀렸으므로 오류발생

>>do_user_signup:  200 SMS 인증문자 발송에 성공하였습니다.
>>do_user_auth:  200 SMS 문자인증에 성공하였습니다.
>>do_user_login_with_wrong_password:  400 패스워드가 잘못 입력되었습니다.
.
[*]Scenario
        1. 회원가입 시 잘못된 형식 email 입력

>>do_user_signup:  400 올바르지 않은 값이 입력되었습니다.(email)
.
[*]Scenario
        1. 회원가입 시 잘못된 형식 phone_number 입력

>>do_user_signup:  400 올바르지 않은 값이 입력되었습니다.(phone_number)

7. Logging

  • 로그는 config/settings/base.py 에서 경로 설정이 가능합니다.

  • 기본적으로 logs 폴더 아래에 생성됩니다.

    • ablyproejct_api.log 예시

      [2022/08/19 22:48:24][INFO][api  :166 ][1.0.0][01012341234][100003]존재하지 않는 사용자입니다.
[2022/08/19 22:48:24][INFO][api  :252 ][1.0.0][01012341234][100003]존재하지 않는 사용자입니다.
[2022/08/19 22:48:24][INFO][api  :73  ][1.0.0][01012341234][102002]SMS 인증문자 발송에 성공하였습니다.
[2022/08/19 22:48:24][INFO][api  :144 ][1.0.0][01012341234][102003]SMS 문자인증에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :190 ][1.0.0][01012341234][101001]로그인에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :265 ][1.0.0][01012341234][100000]요청하신 작업이 정상수행 되었습니다.
[2022/08/19 22:48:25][INFO][api  :73  ][1.0.0][01012341234][102002]SMS 인증문자 발송에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :144 ][1.0.0][01012341234][102003]SMS 문자인증에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :190 ][1.0.0][01012341234][101001]로그인에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :184 ][1.0.0][01012341234][101003]이미 로그인되어 있습니다.
[2022/08/19 22:48:25][INFO][api  :73  ][1.0.0][01012341234][102002]SMS 인증문자 발송에 성공하였습니다.
[2022/08/19 22:48:25][INFO][api  :144 ][1.0.0][01012341234][102003]SMS 문자인증에 성공하였습니다.
[2022/08/19 22:48:26][INFO][api  :190 ][1.0.0][01012341234][101001]로그인에 성공하였습니다.
[2022/08/19 22:48:26][INFO][api  :230 ][1.0.0][01012341234][101002]로그아웃에 성공하였습니다.
[2022/08/19 22:48:26][INFO][api  :224 ][1.0.0][01012341234][101004]이미 로그아웃되어 있습니다.
[2022/08/19 22:48:26][INFO][api  :73  ][1.0.0][01012341234][102002]SMS 인증문자 발송에 성공하였습니다.
[2022/08/19 22:48:26][INFO][api  :144 ][1.0.0][01012341234][102003]SMS 문자인증에 성공하였습니다.
[2022/08/19 22:48:26][INFO][api  :172 ][1.0.0][01012341234][100003]패스워드가 잘못 입력되었습니다.

    • ablyproject_app.log 예시

      [2022/08/19 22:37:02][WARNING][django.request:241 ]Bad Request: /api/login/
[2022/08/19 22:37:02][WARNING][django.request:241 ]Bad Request: /api/user/
[2022/08/19 22:37:03][WARNING][django.request:241 ]Bad Request: /api/login/
[2022/08/19 22:37:04][WARNING][django.request:241 ]Bad Request: /api/logout/
[2022/08/19 22:37:04][WARNING][django.request:241 ]Bad Request: /api/login/

    • ablyproject_err.log 예시

      [2022/08/20 11:02:00][INFO][err  :26  ]UserSignupView-post
[2022/08/20 11:02:00][ERROR][err  :27  ]
Traceback (most recent call last):
  File "D:\lazyer\busincess\ably\ablyproject\ablyproject\api\views.py", line 24, in applicator
    return f(*args,**kwargs)
  File "D:\lazyer\busincess\ably\ablyproject\ablyproject\api\views.py", line 47, in post
    assert True == False
AssertionError

About

Languages

Language:Python 98.8%Language:Dockerfile 1.2%