Skip to content

API_Statement

Yancy edited this page Dec 20, 2020 · 2 revisions

🎈 User

Name HTTP METHOD URL Description
getUserInfo GET /user/info ν•΄λ‹Ή μœ μ € 정보 쑰회
getUsersByAccountBook GET /user/accountBook ν•΄λ‹Ή 가계뢀에 μ†Œμ†λœ μœ μ € λͺ©λ‘ 쑰회
getInviteUsers GET /user/inviteUser ν•΄λ‹Ή 가계뢀에 μœ μ € μΆ”κ°€
updateMembers POST /user/members 가계뢀에 μ΄ˆλŒ€ν•  멀버, 내보낼 멀버 리슀트λ₯Ό λ°›μ•„
μƒˆλ‘œμš΄ 가계뢀 멀버 리슀트둜 μˆ˜μ •
updateUserInfo POST /user μœ μ € 정보 μˆ˜μ •
postLoginGithub POST /user/githublogin κΉƒν—ˆλΈŒ OAuth 둜그인
postLoginNaver POST /user/naverlogin 넀이버 OAuth 둜그인
postLoginKakao POST /user/kakaologin 카카였 OAuth 둜그인

🎈 Payment

Name HTTP METHOD URL Description
getPayments GET /payment μ„ νƒν•œ κ°€κ³„λΆ€μ˜ λͺ¨λ“  κ²°μ œμˆ˜λ‹¨ 쑰회
getTransactions GET /payment/:cardName/:type/:year/:month μ„ νƒν•œ μΉ΄λ“œμ˜ [:year], [:month]의 κ²°μ œλ‚΄μ—­ 상세 쑰회
- type은 all(μˆ˜μž…+μ§€μΆœ), μˆ˜μž…, μ§€μΆœ
addPayment POST /payment κ²°μ œμˆ˜λ‹¨ μΆ”κ°€
updatePayment PATCH /payment κ²°μ œμˆ˜λ‹¨ 정보 μˆ˜μ •
deletePayment DELETE /payment κ²°μ œμˆ˜λ‹¨ μ‚­μ œ

🎈 Transaction

Name HTTP METHOD URL Description
getTransactions GET /transaction ν•΄λ‹Ή κ°€κ³„λΆ€μ˜ 거래 λ‚΄μ—­ 쑰회
getCalendarTransactions GET /transaction/:year/:month μ„ νƒν•œ [:year], [:month]에 λ§žλŠ” κ±°λž˜λ‚΄μ—­ 쑰회
addTransaction POST /transaction 거래 λ‚΄μ—­ μΆ”κ°€
updateTransaction PATCH /transaction 거래 λ‚΄μ—­ μˆ˜μ •
deleteTransaction DELETE /transaction 거래 λ‚΄μ—­ μ‚­μ œ

🎈 AccountBook

Name HTTP METHOD URL Description
getAllAccountBooks GET /accountBook λ‘œκ·ΈμΈν•œ μ‚¬μš©μžμ˜ κΆŒν•œμ΄ μžˆλŠ” λͺ¨λ“  가계뢀 λͺ©λ‘ 쑰회
getAccountBook GET /accountBook/:accountBookId νŠΉμ • 가계뢀 쑰회
createAccountBook POST /accountBook 가계뢀 생성
addAccountBookUsers POST /accountBook/users 가계뢀에 μœ μ € μΆ”κ°€
addAccountBookTag POST /accountBook/tag 가계뢀에 tag μΆ”κ°€
updateAccountBook PATCH /accountBook 가계뢀 이름 μˆ˜μ •
updateAccountBookTag PATCH /accountBook/tag 가계뢀 tag 이름 μˆ˜μ •
deleteAccountBook DELETE /accountBook/:accountBookId 가계뢀 μ‚­μ œ
deleteAccountBookTag DELETE /accountBook/:accountBookId/tag/:tagName 가계뢀 tag μ‚­μ œ

Clone this wiki locally