4. API Design

API 응답 (JSON)

 {  
      status: ".."
      message: ".."
 }

• status

  • SUCCESS: '성공'
  • FAIL: '사용자 요청 오류'
  • ERROR: '서버에러'

• message

  • 응답 data

회원관리 /user/~

---

• 회원가입 요청 [POST] /user/insert

     {  
          id: "f-lab"
          password: "123"
          name: "spring"
     }

• 회원가입 응답

     {
         "status": "SUCCESS",
         "message": "Member Resgistration Success"
     }

• 로그인 [POST] /user/login
• 회원정보 수정 [put] /user/update
• 회원정보 삭제 [post] /user/delete

가게 조회 /shop/~

---

• 브랜드별 가게 조회 [GET] /shop/brand/{brand}

{
    "status": "SUCCESS",
    "message": [
        {
            "shopId": 4,
            "brand": "도쿄미식당",
            "category": "돈까스",
            "location": "다산"
        }
    ]
}

• 전체 가게 조회 [GET] /shop/all
• 카테고리별 가게 조회 [GET] /shop/category/{category}
• 현재 영업중인 가게 조회 [GET] /shop/open
• 현재 영업중인 카테고리별 가맹점 조회 [GET] /shop/open/{category}
• 전체 지역별 가맹점 조회 [GET] /shop/location/{location}
• 현재 영업중인 지역별 가맹점 조회 [GET] /shop/open/{location}
• 현재 영업중인 전체 브랜드별 가맹점 조회 [GET] /shop/open/{brand}
• 배달/포장에 따른 카테고리 리스트 제공 : [GET] /shop/categoryLisyBytransport
• 서비스 이용자 주소 입력 : [PUT] /shop/RegisteLocation
• 알림 및 쿠폰 정보 리스트 : [GET] /shop/NotificationList
• 검색 : [GET] /shop/Search

최근 주문 기록 페이지

• 최근 주문 목록 조회 [GET] /shop/RecentOrderList

찜 페이지

• 찜 및 찜 리스트 조회 [GET] /shop/ChoiceList

카테고리 페이지

• 가맹점 등급별 정렬 리스트 조회 [GET]/shop/SortShopByGrade

주문 관리 페이지

• 가게 영업 시작 [PUT] /shop/start
• 영업 마감 등록 [PUT] /shop/close
• 가맹점주가 소비자에게 주문 수락 여부 메세지 전송을 위한 주문 수락 [POST] /shop/order/accept
• 가맹점주가 소비자에게 주문 수락 여부 메세지 전송을 위한 주문 취소 [POST] /shop/order/refusal
• 현재 수락한 주문 정보 조회 [GET] /shop/order/now
• 수락한 주문 정보 변경 [PUT] /shop/order/now/change
• 배달 소요 시간 등록 [GET] shop/DeliveryTimeAtBuyer
• 라이더 매칭 및 도착 소요시간 확인 [GET] shop/DeliveryTimeAtShop
• 구매자 정보 전송 [POST] shop/SendBuyerInfo