parkgeonhu/drf-RESTful-chat

Chat application Backend server based on Django Rest FrameWork

drf-RESTful-chat

1. 채팅

1.1 기능

1.1.1 회원

1. 회원가입

2. 로그인

3. 회원정보 수정

1.2 기술 스택

• Django Rest Framework

1.3 API 문서

회원가입

사용자 회원가입하는 부분입니다.

• URL

  /api/auth/sign-up

• Method : POST

• URL Params

  Required: none

  Optional: none

• Data Params

  {
    "phone": "01011111111",
    "password": "!ejrqo401",
    "nickname" : "hello" 
  }

• Success Response:

  • Code: 201

    Content:

    {
      "user": {
        "phone": "01011111111",
        "nickname": "hello"
      }
    }

• Error Response:

  • Code: 400 UNAUTHORIZED

    Content: { error : "Log in" }

• Notes:

로그인

사용자 로그인을 요청하는 부분입니다.

• URL

  /api/auth/login

• Method : POST

• Header Params

• URL Params

  Required: none

  Optional: none

• Data Params

  {
    "phone": "01011111111",
    "password": "!ejrqo401"
  }

• Success Response:

  • Code: 200

    Content:

    {
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo2LCJ1c2VybmFtZSI6IjAxMDExMTExMTExIiwiZXhwIjoxNTk1ODM0ODM5LCJwaG9uZSI6IjAxMDExMTExMTExIiwib3JpZ19pYXQiOjE1OTUyMzAwMzl9.5shkJlNWM4lDv78-WnrChxWREv1BCxDn1CiBptbxHIc"
    }

• Error Response:

  • Code: 400 UNAUTHORIZED

    Content: { error : "Log in" }

• Notes:

  응답결과는 인증이 필요한 부분에 JWT 토큰값입니다.

사용자 정보 조회

사용자 본인의 정보를 요청하는 부분입니다.

• URL

  /api/users/me

• Method : GET

• Header Params

  Authorization 에 로그인 시 얻은 토큰을 넣어줍니다.

  Authorization : JWT <_jwt token>

• URL Params

  Required: none

  Optional: none

• Data Params

• Success Response:

  • Code: 200

    Content:

    {
      "phone": "01011111111",
      "nickname": "hello"
    }

• Error Response:

  • Code: 400 UNAUTHORIZED

    Content: { error : "Log in" }

• Notes:

  Authorization에 jwt 토큰을 넣어주는 것을 아셔야 합니다.

사용자 정보 수정

사용자 정보를 수정하는 부분입니다.

• URL

  /api/users/me

• Method : PATCH

• Header Params

  Authorization 에 로그인 시 얻은 토큰을 넣어줍니다.

  Authorization : JWT <_jwt token>

• URL Params

  Required: none

  Optional: none

• Data Params

  {
    "nickname" : "test1",
    "phone" : "1111",
    "password" : "hello",
    "is_staff": true
  }

• Success Response:

  • Code: 201

    Content:

    {
        "phone": "01011111111",
        "nickname": "test1",
        "uuid": "78cee909-95d9-4ef4-bdda-7f12ac9a4657"
    }

• Error Response:

  • Code: 400 UNAUTHORIZED

    Content: { error : "Log in" }

• Notes:

  Authorization에 jwt 토큰을 넣어주는 것을 아셔야 합니다.

2. 사용법

2.1 백엔드(p1_api)

Install Dependencies

python -m pip install --upgrade pip
pip install -r requirements.txt

Run Tests with pytest module

python manage.py makemigrations app
python manage.py migrate
pytest

Run server in dev environment

python manage.py makemigrations app
python manage.py migrate
python manage.py runserver

Postman Collection

License

This software is distributed under MIT license.

Written with

• StackEdit.