API 명세서

1. 음식점 API

1.1. 음식점 목록 조회

다양한 조건으로 음식점 목록을 검색하고 조회할 수 있는 API입니다.

• URL: /api/v1/restaurants
• Method: GET
• 설명:
  • 페이징 처리된 음식점 목록을 반환합니다.
  • 카테고리 필터링과 키워드 검색을 지원합니다.
  • 음식점의 평균 평점과 리뷰 수를 포함합니다.
  • 최신 등록순으로 정렬됩니다.
• Query Parameters:

page: 페이지 번호 (기본값: 1)
size: 페이지 크기 (기본값: 10)
category: 카테고리 필터 (선택) - 한식, 중식, 일식, 양식 등
keyword: 검색어 - 이름, 주소 검색 (선택, 최소 2글자 이상)

• Response:

{
    "content": [
        {
            "id": 1,
            "name": "맛있는 식당",
            "category": "한식",
            "address": "서울시 강남구",
            "phone": "02-1234-5678",
            "description": "전통 한식집",
            "avgRating": 4.5,
            "reviewCount": 100,
            "createdAt": "2024-12-27T10:00:00"
        }
    ],
    "pageable": {
        "page": 1,
        "size": 10,
        "totalElements": 100,
        "totalPages": 10
    }
}

1.2. 음식점 상세 조회

특정 음식점의 상세 정보와 메뉴 목록을 조회하는 API입니다.

• URL: /api/v1/restaurants/{id}
• Method: GET
• 설명:
  • 음식점의 기본 정보를 제공합니다.
  • 해당 음식점의 전체 메뉴 목록을 함께 반환합니다.
  • 평균 평점과 총 리뷰 수를 포함합니다.
  • 각 메뉴별 리뷰 수도 함께 제공됩니다.
  • 존재하지 않는 음식점 ID인 경우 404 에러를 반환합니다.
• Response:

{
		"restaurant": {
		    "id": 1,
		    "name": "맛있는 식당",
		    "category": "한식",
		    "address": "서울시 강남구",
		    "phone": "02-1234-5678",
		    "description": "전통 한식집",
		    "avgRating": 4.5,
		    "reviewCount": 100,
		    "createdAt": "2024-12-27T10:00:00",
	  },
    "menus": [
        {
            "id": 1,
            "name": "김치찌개",
            "price": 8000,
            "description": "돼지고기 김치찌개",
            "category": "찌개",
            "reviewCount": 50
        }
    ]
}

2. 메뉴 API

2.1. 음식점별 메뉴 목록 조회