Nexters / 8potatoes-server

휴게소 먹거리 추천 서비스🍟🍢
1 stars 0 forks source link

[External API] 휴게소 상세 조회 API 관련 #17

Closed jun108059 closed 2 months ago

jun108059 commented 2 months ago

✍🏻 Description

휴게소 상세 조회 API 작성

  1. Request : 휴게소 코드
  2. Response : 휴게소 이름, 주소, 영업시간, 전화번호, 주유소가격, 주유소 정보, 편의시설 list{편의시설 이름, 편의시설 이미지 URL}

API : [GET] 휴게소 상세 정보(메뉴, 기본 정보) 조회 API

응답 데이터

필드 이름 타입 설명
name String 휴게소 이름
direction String? 방면
isOperating Boolean 식당 운영중 여부
startTime String? 식당 운영 시작 시간(07:00)
endTime String? 식당 운영 종료 시간(23:30)
naverRating Float? 네이버 평점
gasStationData GasStationData 주유소 정보
parkingData ParkingData 주차 정보
reststopData ReststopAdditionalData 휴게소 기타 정보
menuData ReststopMenuData 메뉴 데이터 리스트

GasStationData

필드 이름 타입 설명
gasolinePrice String? 휘발유 가격
dieselPrice String? 경유 가격
lpgPrice String? LPG 가격
isElectricChargingStation Boolean 전기차 충전소 여부
isHydrogenChargingStation Boolean 수소차 충전소 여부

ParkingData

필드 이름 타입 설명
smallCarSpace Int 소형 차 공간
largeCarSpace Int 대형 차 공간
disabledPersonSpace Int 장애인 주차 공간
totalSpace Int 총 주차 공간
updateDate String 데이터 업데이트 날짜

ReststopAdditionalData

필드 이름 타입 설명
restaurantOperatingTimes List 식당가 영업시간 정보 리스트
brands List 입점 브랜드 리스트
amenities List 편의시설 리스트
address String 주소
phoneNumber String 전화번호

ReststopMenuData

필드 이름 타입 설명
representativeMenuData List 대표 메뉴 데이터(최대 2개)
totalMenuCount Int 전체 메뉴 개수
recommendedMenuData List 추천 메뉴 데이터
normalMenuData List 일반 메뉴 데이터

RepresentativeMenuData

필드 이름 타입 설명
representativeMenuName String 대표 메뉴 이름
representativeMenuPrice Int 대표 메뉴 가격
representativeMenuImageUrl String 대표 메뉴 이미지
representativeMenuDescription String 대표 메뉴 설명

MenuData

필드 이름 타입 설명
menuName String 메뉴 이름
menuPrice Int 메뉴 가격
isSignatureMenu Boolean 시그니처 메뉴 여부
isPopularMenu Boolean 인기 메뉴 여부
menuCategory String 메뉴 카테고리

Sample JSON

  {
    "name": "망향휴게소",
    "direction": "부산",
    "isOperating": false,
    "startTime": "07:00",
    "endTime": "23:30",
    "naverRating": 3.4,
    "gasStationData": {
      "gasolinePrice": "1,617원",
      "dieselPrice": "1,472원",
      "lpgPrice": "994원",
      "isElectricChargingStation": true,
      "isHydrogenChargingStation": true
    },
    "parkingData": {
      "smallCarSpace": 246,
      "largeCarSpace": 68,
      "disabledPersonSpace": 15,
      "totalSpace": 329,
      "updateDate": "2024.08.13"
    },
    "reststopData": {
      "restaurantOperatingTimes": [
        {
          "restaurantName": "식당가 (라면/우동)",
          "operatingTime": "09:00 ~ 21:00"
        },
        {
          "restaurantName": "달콤커피 커피전문점",
          "operatingTime": "08:00 ~ 22:00"
        }
      ],
      "brands": [
        {
          "brandName": "던킨도너츠",
          "brandLogoUrl": ""
        },
        {
          "brandName": "BBQ",
          "brandLogoUrl": ""
        },
        {
          "brandName": "파스쿠찌",
          "brandLogoUrl": ""
        },
        {
          "brandName": "LYNX",
          "brandLogoUrl": ""
        },
        {
          "brandName": "드롭탑(커피전문점)",
          "brandLogoUrl": ""
        }
      ],
      "amenities": [
        {
          "amenityName": "화장실",
          "amenityLogoUrl": "https://github.com/user-attachments/assets/0f2a2a5b-33a5-4d89-bacb-9a4f55b935de"
        },
        {
          "amenityName": "ATM",
          "amenityLogoUrl": "https://github.com/user-attachments/assets/0f2a2a5b-33a5-4d89-bacb-9a4f55b935de"
        }
      ],
      "address": "충남 천안시 성거읍 요방리 121",
      "phoneNumber": "041-557-4000"
    },
    "menuData": {
      "representativeMenuData": [
        {
          "representativeMenuName": "EX라면",
          "representativeMenuPrice": 4000,
          "representativeMenuImageUrl": "https://github.com/user-attachments/assets/d117754e-92d2-4156-92e7-a2721216c17a",
          "representativeMenuDescription": "한국 고속도로 휴게소 대표라면\r\n\r\n풍성한 건더기에 계란까지 탁!!\r\n\r\n가성비 갑대표 메뉴 EX라면"
        },
        {
          "representativeMenuName": "한우국밥",
          "representativeMenuPrice": 12000,
          "representativeMenuImageUrl": "https://github.com/user-attachments/assets/d117754e-92d2-4156-92e7-a2721216c17a",
          "representativeMenuDescription": "한우고기를 푹 고아낸 육수에\r\n우거지 콩나물 대파 무 등의 각종 야채를 넣고\r\n된장과 고춧가루, 소금, 후추, 국간장 등의\r\n양념을 넣어 푹 끊여낸 음식으로\r\n휴게소에서 대표메뉴로 지정한만큼\r\n푸짐하고 든든한 음식"
        }
      ],
      "totalMenuCount": 49,
      "recommendedMenuData": [
        {
          "menuName": "EX라면",
          "menuPrice": 4000,
          "isSignatureMenu": true,
          "isPopularMenu": true,
          "menuCategory": "한식"
        },
        {
          "menuName": "한우국밥",
          "menuPrice": 12000,
          "isSignatureMenu": true,
          "isPopularMenu": true,
          "menuCategory": "한식"
        },
        {
          "menuName": "곤지암 한우소머리국밥",
          "menuPrice": 12000,
          "isSignatureMenu": true,
          "isPopularMenu": false,
          "menuCategory": "한식"
        },
        {
          "menuName": "얼큰 사파 닭 쌀국수",
          "menuPrice": 12000,
          "isSignatureMenu": false,
          "isPopularMenu": false,
          "menuCategory": "한식"
        },
        {
          "menuName": "해물 순두부",
          "menuPrice": 9000,
          "isSignatureMenu": false,
          "isPopularMenu": false,
          "menuCategory": "한식"
        }
      ]
    }
  }