2.4 API 명세

🚀 Swagger 문서 바로가기

📌 Roome 프로젝트 API 명세서

🔐 회원 API

기능	Method	Path
🗑 회원 탈퇴	DELETE	/api/auth/withdraw
👤 사용자 정보 조회	GET	/api/auth/user
🔓 로그아웃	POST	/api/auth/logout
🔄 토큰 재발급	POST	/api/auth/reissue-token

---

📚 도서 API

기능	Method	Path
📖 등록 도서 목록 조회	GET	/api/mybooks
📑 등록 도서 상세 조회	GET	/api/mybooks/{myBookId}
📝 도서 등록	POST	/api/mybooks
🗑 등록 도서 삭제	DELETE	/api/mybooks

---

✍ 서평 API

기능	Method	Path
🔍 서평 조회	GET	/api/mybooks/{myBookId}/review
✏ 서평 등록	POST	/api/mybooks/{myBookId}/review
🛠 서평 수정	PATCH	/api/mybooks/{myBookId}/review
🗑 서평 삭제	DELETE	/api/mybooks/{myBookId}/review

---

💿 CD 템플릿 API

기능	Method	Path
🔍 CD 템플릿 조회	GET	/api/my-cd/{myCdId}/template
➕ CD 템플릿 생성	POST	/api/my-cd/{myCdId}/template
🛠 CD 템플릿 수정	PATCH	/api/my-cd/{myCdId}/template
🗑 CD 템플릿 삭제	DELETE	/api/my-cd/{myCdId}/template

---

🎵 My CD API

기능	Method	Path
➕ CD 추가	POST	/api/my-cd
🔍 CD 목록 조회	GET	/api/my-cd
📀 특정 CD 조회	GET	/api/my-cd/{myCdId}
🗑 CD 삭제	DELETE	/api/my-cd

---

💬 CD 댓글 API

기능	Method	Path
📝 CD 댓글 작성	POST	/api/my-cd/{myCdId}/comments
🔍 CD 댓글 목록 조회 및 검색	GET	/api/my-cd/{myCdId}/comments
🔍 CD 전체 댓글 목록 조회	GET	/api/my-cd/{myCdId}/comments/all
🗑 CD 댓글 삭제	DELETE	/api/my-cd/{myCdId}/comments/{commentId}

---

🔔 알림 API

기능	Method	Path
📩 알림 목록 조회	GET	/api/notifications
✅ 알림 읽음 처리	PATCH	/api/notifications/{notificationId}/read

---

📜 방명록 API

기능	Method	Path
🔍 방명록 조회	GET	/api/guestbooks/{roomId}
📝 방명록 추가	POST	/api/guestbooks/{roomId}
🗑 방명록 삭제	DELETE	/api/guestbooks/{guestbookId}

---

🏠 방(Room) API

기능	Method	Path
🔍 방 조회	GET	/api/rooms/{roomId}
🏡 사용자별 방 조회	GET	/api/rooms
🎨 방 테마 변경	PUT	/api/rooms/{roomId}
🏗 가구 표시 여부 토글	PUT	/api/rooms/{roomId}/furniture

---

🏗 가구 API

기능	Method	Path
📚 책장 레벨 업그레이드	POST	/api/rooms/{roomId}/furniture/bookshelf/upgrade
💿 CD 랙 레벨 업그레이드	PATCH	/api/rooms/{roomId}/furniture/cd-rack/upgrade

---

🏆 랭킹 API

기능	Method	Path
📊 상위 랭킹 조회	GET	/api/rankings

---

🧑‍🎨 프로필 관리 API

기능	Method	Path
👤 프로필 조회	GET	/api/users/{userId}/profile
🛠 프로필 수정	PATCH	/api/users/profile
🖼 프로필 이미지 업로드	POST	/api/users/image
🗑 프로필 이미지 삭제	DELETE	/api/users/image

---

🤝 하우스메이트(친구) API

기능	Method	Path
➕ 하우스메이트 추가	POST	/api/mates/{targetId}
🗑 하우스메이트 삭제	DELETE	/api/mates/{targetId}
🔍 내가 추가한 메이트 목록 조회	GET	/api/mates/following
🔍 나를 추가한 메이트 목록 조회	GET	/api/mates/followers

---

💳 결제 API

기능	Method	Path
💰 결제 요청	POST	/api/payments/request
✅ 결제 검증	POST	/api/payments/verify
❌ 결제 실패	POST	/api/payments/fail/{orderId}

---

📡 웹소켓(WebSocket) API

기능	Method	Path
📡 WebSocket 연결 정보	GET	/docs/websocket
🔔 알림 타입 정보	GET	/docs/websocket/types

---

이 API 명세서는 프로젝트 개발 상황에 따라 업데이트될 수 있습니다. 🚀