API.md

API 명세서 (API Specification)

이 프로젝트의 REST API 명세서입니다. 서버가 실행 중일 때 http://localhost:3000/api-docs 에서 Swagger UI를 통해 상세 정보를 확인하고 테스트할 수 있습니다.

---

🔐 인증 (Auth)

Base Path: /auth

Method	Endpoint	Description
POST	/	휴대폰 인증 코드 발송 요청
POST	/verify	휴대폰 인증 코드 검증
PUT	/signUp	회원가입
POST	/signIn	로그인
POST	/reset	비밀번호 재설정

---

👤 회원 정보 (User Info & MyPage)

기본 정보 (User Info)

Base Path: /userInfo

Method	Endpoint	Description
PUT	/	유저 생성
POST	/	유저 정보 조회
POST	/all	모든 유저 조회
GET	/userImg/:idx	유저 프로필 이미지 조회
POST	/update	유저 정보 수정
POST	/updateUserImg	유저 프로필 이미지 수정
POST	/updateforcredit	유저 크레딧 갱신

유저 관계 (User Relation)

Base Path: /userRelation

Method	Endpoint	Description
PUT	/	관계 생성 (팔로우 등)
POST	/	관계 목록 조회
DELETE	/delete	관계 삭제 (언팔로우)

칭호 (User Title)

Base Path: /userTitle

Method	Endpoint	Description
PUT	/	칭호 생성
POST	/	칭호 목록 조회
POST	/update	칭호 상태 수정

마이페이지 기타 (Report, Keyword, Alarm, Credit)

Base Path	Method	Endpoint	Description
/report	PUT	/	신고 접수
/report	POST	/all	모든 신고 내역 조회
/report	POST	/byUser	유저별 신고 내역 조회
/report	POST	/update	신고 처리 상태 수정
/keyword	PUT	/	키워드 생성
/keyword	POST	/all	키워드 목록 조회
/keyword	POST	/update	키워드 수정
/alarmType	PUT	/	알림 타입 생성
/alarmType	POST	/all	알림 타입 조회
/alarmType	POST	/update	알림 타입 수정
/creditHistory	PUT	/	크레딧 내역 생성
/creditHistory	POST	/	특정 크레딧 내역 조회
/creditHistory	POST	/all	전체 크레딧 내역 조회
/creditHistory	POST	/update	크레딧 내역 수정

---

📝 의뢰 (Request)

의뢰 정보 (Request Info)

Base Path: /requestInfo

Method	Endpoint	Description
PUT	/	의뢰 생성
GET	/getImage/:idx	의뢰 이미지 조회
POST	/	특정 의뢰 상세 조회
POST	/all	모든 의뢰 조회
GET	/nearby	위치 기반 주변 의뢰 조회
POST	/fetch	의뢰 목록 fetch (페이징/필터 등)
POST	/onlyMine	내가 신청한 의뢰 목록
POST	/howManyrequest	유저의 의뢰 요청 횟수
POST	/howManyAccept	유저의 의뢰 수락 횟수
POST	/getHowManyComplete	유저의 의뢰 완료 횟수
POST	/title	제목으로 의뢰 검색
POST	/update	의뢰 정보 수정
POST	/updateImg	의뢰 이미지 수정

의뢰 신청자 (Request Applicant)

Base Path: /requestApplicant

Method	Endpoint	Description
PUT	/	의뢰 신청
POST	/all	모든 신청자 조회
POST	/applyRequest	내가 신청한 의뢰 정보 조회
POST	/getApply	유저의 신청 정보 조회
POST	/getAccepted	수락된 신청 조회
POST	/getFinished	완료된 신청 조회
POST	/howManyApplicant	해당 의뢰의 신청자 수 조회
POST	/update	신청 상태 수정

관심 의뢰 (Interest Request)

Base Path: /interestRequest

Method	Endpoint	Description
PUT	/	관심 의뢰 등록 (찜하기)
POST	/all	모든 관심 의뢰 조회
POST	/exactly	특정 관심 의뢰 확인
POST	/fetch	유저의 관심 의뢰 목록 조회
POST	/update	관심 의뢰 수정
DELETE	/delete	관심 의뢰 해제

의뢰 댓글 (Request Comment)

Base Path: /requestComment

Method	Endpoint	Description
PUT	/	댓글 작성
POST	/all	모든 댓글 조회
POST	/	특정 의뢰의 댓글 조회
POST	/update	댓글 수정
DELETE	/delete	댓글 삭제

---

💬 커뮤니티 & 채팅 (Community & Chat)

커뮤니티 (Community)

Base Path	Method	Endpoint	Description
/communityPost	PUT	/	게시글 작성
/communityPost	POST	/	유저별 게시글 조회
/communityPost	POST	/all	전체 게시글 조회
/communityPost	POST	/update	게시글 수정
/communityComment	PUT	/	댓글 작성
/communityComment	POST	/byPost	게시글별 댓글 조회
/communityComment	POST	/byUser	유저별 댓글 조회
/communityComment	POST	/update	댓글 수정

채팅 (Chat)

Base Path	Method	Endpoint	Description
/chatRoom	PUT	/	채팅방 생성
/chatRoom	POST	/all	모든 채팅방 조회
/chatRoom	POST	/check	채팅방 존재 여부 확인
/chatMessage	PUT	/	메시지 전송
/chatMessage	POST	/room	방별 메시지 내역 조회
/chatList	PUT	/	채팅 목록 추가
/chatList	POST	/mine	내 채팅 목록 조회

---

💳 결제 (Payments)

Base Path: /v1/payments

Method	Endpoint	Description
POST	/confirm	결제 승인 요청