PayHere 가계부 과제

Financial Ledger REST API 문서입니다.

Account

Base URI: /api/v1/account

sing-up | 회원가입

POST /sign-up

**Request**
***email은 Email 형식을 지켜야 합니다.
password는 8자 이상 조건입니다.***
{
	"email": "[email protected]",
	"password": "a1234566",
	"name": "sol"
}

**Response**
{
    "id": 1,
    "email": "[email protected]",
    "name": "sol",
    "loginAt": "2021-12-05T07:32:50.729628",
    "message": {
        "status": "SIGN_UP_OK",
        "msg": "회원가입이 성공하였습니다."
    }
}

login | 로그인

POST /login

**Request**
{
  "email": "[email protected]",
  "password": "a1234567"
}

**Response**
{
    "id": 1,
    "email": "[email protected]",
    "name": "sol",
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzb2xAZ21haWwuY29tIiwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTYzODY4OTUzNSwiZXhwIjoxNjM4NjkzMTM1fQ.sl4t5Ze8mnP20ydFRintSmwFg0K3p-JlL_MOelh45uc",
    "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzb2xAZ21haWwuY29tIiwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTYzODY4OTUzNSwiZXhwIjoxNjM4OTQ4NzM1fQ.mNrvWhkLdo8oZNe0a9A9Nddx_ozxCY6RnNKByJC5y8k",
    "message": {
        "status": "LOGIN_OK",
        "msg": "성공적으로 로그인 하였습니다."
    }
}

logout | 로그아웃

POST /logout

**Request**
-H Authorization: bearer eyjhb...

**Response**
{
    "status": "LOGOUT_OK",
    "msg": "성공적으로 로그아웃 되었습니다."
}

token reissue | 토큰 재발급

GET /refresh/{email}

**Request**
-H ****refreshToken: eyJhbGciOiJIUzI1NiJ9....

**Response**
{
    "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzb2xAZ21haWwuY29tIiwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTYzODY4OTYyMSwiZXhwIjoxNjM4NjkzMjIxfQ.jKsCF4eGJoGDgON4GCWqeygicjZ65FicyoduIQwQTCc",
    "refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzb2xAZ21haWwuY29tIiwicm9sZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTYzODY4OTYyMSwiZXhwIjoxNjM4OTQ4ODIxfQ.Iw-F0m_li3mDFCBOrA0O_OjlBw03WbmAhHXzm5ezUE0",
    "message": {
        "status": "TOKEN_REISSUE_OK",
        "msg": "성공적으로 토큰이 재발급 되었습니다."
    }
}

Ledger

Base URI: /api/v1/ledger

create | 생성

POST /

**Request**
-H Authorization: bearer eyjhb...
{
	"content": "이마트에서 사용한 금액",
	"price" : 52000
}

**Response**
{
    "id": 1,
    "writeAt": "2021-12-05",
    "content": "이마트에서 사용한 금액",
    "price": 52000,
    "createAt": "2021-12-05T07:10:00.081523",
    "updateAt": "2021-12-05T07:10:00.081532",
    "message": {
        "status": "LEDGER_OK",
        "msg": "가계부 내역을 성공적으로 생성하였습니다."
    }
}

update | 수정

PATCH /

**Request**
-H Authorization: bearer eyjhb...
{
	"id": 1,
	"content": "이마트24에서 사용한 금액",
	"price": 32000
}

**Response**
{
    "id": 1,
    "writeAt": "2021-12-05",
    "content": "이마트24에서 사용한 금액",
    "price": 32000,
    "createAt": "2021-12-05T07:10:00.081523",
    "updateAt": "2021-12-05T07:36:59.261836",
    "message": {
        "status": "LEDGER_OK",
        "msg": "가계부 내역을 성공적으로 수정하였습니다."
    }
}

get one | 단일 세부내역 조회

GET /{ledgerId}

**Request**
-H Authorization: bearer eyjhb...

**Response**
{
    "id": 1,
    "writeAt": "2021-12-05",
    "content": "이마트24에서 사용한 금액",
    "price": 32000,
    "createAt": "2021-12-05T07:10:00.081523",
    "updateAt": "2021-12-05T07:36:59.261836",
    "message": {
        "status": "LEDGER_OK",
        "msg": "가계부 단일 세부내역 조회를 성공하였습니다."
    }
}

get all | 전체 조회