๐ API ๋ช
์ธ์ - prgrms-be-devcourse/NBE4-5-3-Team01 GitHub Wiki
์์
์บ๋ฆฐ๋ API Documentation
์์
์บ๋ฆฐ๋ ์๋น์ค์ API ๋ฌธ์๋ฅผ ๋ด๊ณ ์์ต๋๋ค.
Overview
- Title: ์์
์บ๋ฆฐ๋ API
- Description: ์์
์บ๋ฆฐ๋ ์๋น์ค์ ๊ดํ API ๋ฌธ์ํ
- Version: 1.0.0
- Base URL:
http://localhost:8080/api/v1
- Security: JWT (Bearer ํ ํฐ ์ฌ์ฉ)
Endpoints
Users API
Method |
URL |
Summary |
POST |
/user/signup |
ํ์๊ฐ์
|
POST |
/user/login |
๋ก๊ทธ์ธ |
POST |
/user/refresh |
JWT ์ฌ๋ฐ๊ธ |
POST |
/user/image |
์ด๋ฏธ์ง ๋ณ๊ฒฝ |
PUT |
/user/userIntro |
์๊ธฐ์๊ฐ ๋ณ๊ฒฝ |
PUT |
/user/profileName |
์ด๋ฆ ๋ณ๊ฒฝ |
PATCH |
/user/calendar-visibility |
์บ๋ฆฐ๋ ๊ณต๊ฐ ์ฌ๋ถ ์์ |
GET |
/user/search |
์ ์ ๊ฒ์ |
GET |
/user/getUsers |
๋ด ์ ์ ์ ๋ณด ์กฐํ |
GET |
/user/{user-id} |
์ ์ ID๋ก ์กฐํ |
GET |
/user/byToken |
ํ ํฐ์ผ๋ก ์ ์ ์กฐํ |
GET |
/user/byCookie |
์ฟ ํค๋ก ์ ์ ์กฐํ |
GET |
/user/spotify-token |
Spotify ํ ํฐ ์กฐํ |
GET |
/user/logout |
๋ก๊ทธ์์ |
GET |
/user/testApi |
ํ
์คํธ API |
GET |
/user/check-duplicate |
์์ด๋ ์ค๋ณต ํ์ธ |
Calendar API
Method |
URL |
Summary |
GET |
/calendar |
๋จผ์ฌ๋ฆฌ ์บ๋ฆฐ๋ ์กฐํ |
POST |
/calendar |
์บ๋ฆฐ๋ ์์ฑ |
GET |
/calendar/{calendar-date-id} |
ํน์ ๋ ์ง ์บ๋ฆฐ๋ ์กฐํ |
PATCH |
/calendar/{calendar-date-id}/memo |
๋ฉ๋ชจ ์์ |
PUT |
/calendar/{calendar-date-id}/music |
์์
๊ธฐ๋ก ์์ |
GET |
/calendar/today |
์ค๋ ๋ ์ง ์บ๋ฆฐ๋ ์กฐํ |
Music API
Method |
URL |
Summary |
GET |
/music |
์ ์ฒด ์์
๋ชฉ๋ก ์กฐํ |
GET |
/music/{id} |
ID๋ก ์์
์กฐํ |
DELETE |
/music/{id} |
ID๋ก ์์
์ญ์ |
POST |
/music/save-all |
์์
๋ฆฌ์คํธ ์ ์ฅ |
GET |
/music/spotify/{id} |
Spotify ID๋ก ๊ฒ์ |
POST |
/music/spotify/{id} |
Spotify ID๋ก ์ ์ฅ |
GET |
/music/spotify/search |
ํค์๋๋ก Spotify ๊ฒ์ |
GET |
/music/spotify/playlist |
์ฌ์ฉ์ Spotify Playlist ์กฐํ |
GET |
/music/spotify/playlist/{playlistId} |
Playlist ํธ๋ ์กฐํ |
GET |
/music/spotify/artist/{artistId}/top-tracks |
์ํฐ์คํธ ์ธ๊ธฐ๊ณก ์กฐํ |
GET |
/music/recent/random/{userId} |
๋๋ค ์ต๊ทผ ์์
์กฐํ |
Notification API
Method |
URL |
Summary |
GET |
/notifications |
์ ์ฒด ์๋ฆผ ์กฐํ |
GET |
/notifications/{notification-id} |
์๋ฆผ ๋จ๊ฑด ์กฐํ |
GET |
/notifications/modify |
๋ณ๊ฒฝ ๊ฐ๋ฅ ์๋ฆผ ๋ชฉ๋ก ์กฐํ |
GET |
/notifications/lists |
์ฌ์ฉ์ ์๋ฆผ ์กฐํ |
PUT |
/notifications/{notification-id}/modify |
์๋ฆผ ์๊ฐ ๋ณ๊ฒฝ |
PATCH |
/notifications/update |
์๋ฆผ ์ค์ ์
๋ฐ์ดํธ |
Notification List API
Method |
URL |
Summary |
GET |
/notification-lists |
๋ด ์๋ฆผ๋ฆฌ์คํธ ์กฐํ |
PATCH |
/notification-lists/{notificationList-id} |
์๋ฆผ ์ฝ์ ์ฒ๋ฆฌ ๋จ๊ฑด |
DELETE |
/notification-lists/{notificationList-id} |
์๋ฆผ ์ญ์ |
PATCH |
/notification-lists/mark-all-read |
์ ์ฒด ์ฝ์ ์ฒ๋ฆฌ |
Subscription (ํธ์ ๊ตฌ๋
)
Method |
URL |
Summary |
POST |
/push/subscribe |
ํธ์ ๊ตฌ๋
์ ๋ณด ์ ์ฅ |
Follows API
Method |
URL |
Summary |
POST |
/follows/{user-id} |
ํ๋ก์ฐ ์์ฒญ |
DELETE |
/follows/delete/{user-id} |
ํ๋ก์ฐ ์ญ์ |
DELETE |
/follows/reject/{user-id} |
ํ๋ก์ฐ ๊ฑฐ์ |
PUT |
/follows/accept/{user-id} |
ํ๋ก์ฐ ์๋ฝ |
GET |
/follows/my |
๋ด ํ๋ก์ ๋ชฉ๋ก ์กฐํ |
GET |
/follows/my/pending |
ํ๋ก์ ์์ฒญ ๋ชฉ๋ก ์กฐํ |
GET |
/follows/following/{user-id} |
์ ์ ์ ํ๋ก์ ๋ชฉ๋ก ์กฐํ |
GET |
/follows/follower/{user-id} |
์ ์ ์ ํ๋ก์ ๋ชฉ๋ก ์กฐํ |
GET |
/follows/count/{user-id} |
ํ๋ก์ฐ ์ ์กฐํ |
Membership API
Method |
URL |
Summary |
POST |
/membership/init |
๊ธฐ๋ณธ ๋ฉค๋ฒ์ญ ์์ฑ |
POST |
/membership/cancel |
๋ฉค๋ฒ์ญ ํด์ง |
GET |
/membership/my |
๋ด ๋ฉค๋ฒ์ญ ์กฐํ |
GET |
/membership/admin |
์ ์ฒด ๋ฉค๋ฒ์ญ ๋ชฉ๋ก (๊ด๋ฆฌ์ ์ ์ฉ) |
PATCH |
/membership/admin/{id} |
๋ฉค๋ฒ์ญ ์์ (๊ด๋ฆฌ์ ์ ์ฉ) |
Payment API
Method |
URL |
Summary |
POST |
/payment/subscribe |
์ ๊ธฐ ๊ฒฐ์ ๊ตฌ๋
์์ฒญ (ํ ์ค) |
POST |
/payment/confirm |
๊ฒฐ์ ํ์ธ ์์ฒญ |
Recap API
Method |
URL |
Summary |
GET |
/recap?startDate=&endDate= |
์ ์ฒด ์์
๊ธฐ๋ก ์กฐํ |
Email API
Method |
URL |
Summary |
GET |
/userEmail/emailAuth?email= |
์ด๋ฉ์ผ ์ธ์ฆ์ฝ๋ ๋ฐ์ก |
Spotify Connect API
Method |
URL |
Summary |
GET |
/spotify/callback |
Spotify ๊ณ์ ์ฐ๋ ์ฝ๋ฐฑ |
GET |
/spotify/logout |
Spotify ๋ก๊ทธ์์ |