[가계부 시스템] 3. API 설계

2021.07.15 - [Project] - [가계부 시스템] 2. 시스템 설계 - 아키텍쳐, DB

[가계부 시스템] 2. 시스템 설계 - 아키텍쳐, DB

본격적인 내부구현에 앞서 우선 클라이언트에서 어떻게 데이터를 요청할 것인지를 먼저 정해야했다. 

REST API로 설계하기로했다. 아래는 그 목록이다.

 

/book/{YYYY-mm}

1. GET : YYYY-mm 에 해당하는 가계부를 가져온다. 여기에는 총 수입 지출과, 각각의 수입(지출)항목, 수입(지출)분류, 자산 종류와 자산별 현황이 포함된다.

2. POST : YYYY-mm 가계부를 생성한다. 이미 존재한다면 실패한다.

/accounts/{date}

GET : time이 {date}인 accounte(수입,지출항목 각각)들을 가져온다.

/accounts/{aid}

PUT : 식별자가 aid인 account(수입,지출항목 각각)를 수정한다.

DELETE : 식별자가 aid인 account(수입,지출항목 각각)를 삭제한다.

/accounts

POST : 새 account를 생성한다.

/accounts/{type}/{YYYY-mm}

{type} 은 Income 혹은 Expenditure 입니다.

GET : YYYY-mm가계부에서 accountType이 {type}인 account(수입,지출항목 각각)들을 가져옵니다.

/accounts/conversion/{YYYY-mm}

GET : YYYY-mm 가계부에서 conversionaccount(자산간 변환 항목 각각)를 모두 가져옵니다.

/accounts/conversion/

POST : 새 conversionaccount(자산간 변환 항목 각각)를 생성합니다.

/assets/{name}

GET : assetName이 {name}인 asset(자산)를 가져옵니다.

POST : assetName이 {name}인 asset(자산)를 생성합니다.

/assets

GET : 모든 asset(자산)을 가져옵니다.

/categories/{type}

{type} 은 Income 혹은 Expenditure 입니다.

GET : type이 {type}인 category(각 수입, 지출의 분류)들을 가져옵니다.

/categories/{type}/{name}

{type} 은 Income 혹은 Expenditure 입니다.

GET : type이 {type}이고 name이 {name}인 category(각 수입, 지출의 분류)를 가져옵니다.

POST : type이 {type}이고 name이 {name}인 category(각 수입, 지출의 분류)를 생성합니다.