HyunAm0225/ledger_project

가계부 프로젝트

Ledger Project

Run Server

docker-compose up -d --no-deps --build

Test Django Server

docker-compose run django python manage.py test

API 명세

User

token_info

{
  "access_token": str,
  "refresh_token": str,
  "expires_at": int,
}

user_info

{
  "id": int,
  "email": str,
  "created_at": str,
  "updated_at": str,
}

Users.register

• 회원가입 API
• [POST] /users/register/
• permission_classes : AllowAny

request.body

{  
  "email" : str,
  "password" : str
}

response

{
  "token" : <token_info>,
  "user" : <user_info>
}

Users.Login

• 로그인 API
• [POST] /users/login/
• permission_classes : AllowAny

request.body

{
  "email" : str,
  "password" : str
}

res

{
  "user" : <user_info>,
  "token_info" : <token_info>
}

Users.Logout

• 로그아웃 API
• [POST] /users/logout/
• permission_classes : IsAuthenticated

request.body

{
  "refresh_token" : str,
}

response

{
  "result" : True,
}

Ledger

ledger_info

{
  "id": int,
  "user": int,
  "memo": str,
  "amount": int,
  "created_at": str,
  "updated_at": str,
  "is_active": bool,
}

[POST] ledegers

• 금액, 메모 작성
• [POST] /ledgers/
• permission_classes : IsAuthenticated

request.body

{
  "amount" : int, // biginteger field
  "memo" : str
}

response

{
  "result" : bool,
  "ledgers" : <ledger_info>
}

[PATCH] ledgers.pk

• 수정기능
• [PATCH] /ledgers/<ledger_id>/
• permission_classes : IsAuthenticated

request.body

{
  "amount" : int, // nullable
  "memo" : str // nullable
}

response

{
  "result" : bool,
  "ledgers" : ledger_info
}

[DELETE] ledgers.pk

• 삭제기능
• [DELETE] /ledgers/<ledger_id>/
• permission_classes : IsAuthenticated

request.body

{

}

response

{
  "result" : bool,
  "ledgers" : <ledger_info>
}

[PATCH] ledgers.pk.restore

• 복구기능
• [PATCH] /ledgers/<ledger_id>/restore/
• permission_classes : IsAuthenticated

request.body

{

}

response

{
  "result" : bool,
  "ledgers" : <ledger_info>
}

[GET] ledgers

• 가계부 리스트 보는 기능
  • 추가기능(해당 유저의 가계부만 보이게 구현)
• [GET] /ledgers/
• permission_classes : IsAuthenticated

request.body

{

}

response

{
  "result" : bool,
  "ledgers" : [<ledger_info>]
}

[GET] ledgers.pk

• 가계부 세부내역 보는 기능
  • 추가기능(해당 유저의 가계부만 보이게 구현)
• [GET] /ledgers/<ledger_id>/
• permission_classes : IsAuthenticated

request.body

{

}

response

{
  "result" : bool,
  "ledgers" : <ledger_info>
}