숙박 API 명세서 - TEAM-PROJECT-ACC/trip-at-five-client GitHub Wiki

숙박 API 명세서

작성자 임성준

숙박업소 CRUD

IDX 기능명 설명 Method API Path Request Body / Params Response Body
Accommodation 숙박업소 목록 조회 전체 숙박업소 목록 조회 GET /accommodations accomListInfo List
숙박업소 등록 숙박업소 정보 등록 POST /accommodations accomInfo
숙박업소 수정 숙박업소 정보 수정 PUT /accommodations updatedAccomInfo
숙박업소 삭제 숙박업소 정보 삭제 DELETE /accommodations accomNo
숙박업소 상세 조회 특정 숙박업소 상세 조회 GET /accommodations/{accomNo} accomNo, checkIn, checkOut, personal accomDetailDTO

accomListInfo

accomListInfo {
  "keyword": "키워드",
  "location": "지역명",
  "checkIn": "체크인날짜",
  "checkOut": "체크아웃날짜",
  "guests": "인원수",
  "page": 0, // 페이지 수
  "size": 0 // 데이터 수
}

accomInfo

accomInfo {
  "accomName": "숙박업소명",
  "accomDesc": "숙박업소설명",
  "accomLat": 0, // 위도
  "accomLon": 0, // 경도
  "accomAddr": "주소",
  "accomPhone": "01012345678",
  "pubFacInfo": "공용편의시설정보",
  "inRoomFacInfo": "객실내시설정보",
  "etcFacInfo": "기타시설정보",
  "accomTypeNo": 0, // 숙박유형번호
  "accomImgInfo" : {
    "accomImgOrgName": "이미지원본이름",
    "accomImgChgName": "이미지경로명",
    "accomNo": 0, // 숙박업소번호
  }
}

updatedAccomInfo

updatedAccomInfo {
  "accomNo": 0, // 숙박업소번호
  "accomName": "숙박업소명",
  "accomDesc": "숙박업소설명",
  "accomLat": 0, // 위도
  "accomLon": 0, // 경도
  "accomAddr": "주소",
  "accomPhone": "01012345678",
  "pubFacInfo": "공용편의시설정보",
  "inRoomFacInfo": "객실내시설정보",
  "etcFacInfo": "기타시설정보",
  "accomTypeNo": 0 // 숙박유형번호
}

객실 CRUD

IDX 기능명 설명 Method API Path Request Body / Params Response Body
Accommodation 객실 목록 조회 전체 객실 목록 조회 GET /rooms accomNo List
객실 등록 객실 정보 등록 POST /rooms roomInfo
객실 수정 객실 정보 수정 PUT /rooms updatedRoomInfo
객실 삭제 객실 정보 삭제 DELETE /rooms accomNo
객실 상세 조회 특정 객실 상세 조회 GET /rooms/{roomNo} roomNo

예약

IDX 기능명 설명 Method API Path Request Body Response Body
Reservation 예약 및 결제 정보 조회 예약페이지. 예약 정보, 객실정보, 결제 정보 GET /reservations roomInfo, reservationInfo, paymentInfo reservationDTO
Payment 결제승인 부트페이를 활용한 결제승인처리 POST /payments/confirm paymentInfo
결제단건조회 부트페이를 활용한 결제단건조회 GET /payments/{receiptId} receiptId

내 예약 내역

IDX 기능명 설명 Method API Path Request Body Response Body
Member, Reservation 예약 내역 마이페이지에서 내 예약 정보 조회 GET /members/{memNo}/reservations memNo List
예약 상세 조회 마이페이지에서 특정 예약 상세 정보 조회 GET /members/{memNo}/reservations/{resCd} memNo, resCd
예약취소요청 예약정보 상태 데이터 PROCESSING으로 변경 PATCH /members/{memNo}/reservations/{resCd} memNo, resCd

관리자 예약

IDX 기능명 설명 Method API Path Request Body Response Body
Admin, Reservation 예약내역조회 전체예약내역조회 GET /reservations
예약취소처리 예약정보 상태 데이터 CANCEL로 변경 PATCH /reservations/{resCd} resCd
결제취소처리 부트페이를 활용한 결제취소처리 POST /payments/cancel receiptId
⚠️ **GitHub.com Fallback** ⚠️