Skip to content

Docs API 문서

Jump to bottom
DongHun Kim edited this page Apr 30, 2021 · 1 revision

1. 사용가능한 API 목록

GET

번호 구분 요청 메서드 URL
1 리스트 - 메인요리 GET /banchan/best
2 리스트 - 베스트 카테고리 GET /banchan/best/{categoryId}
3 상세보기 - id로 상세보기 GET /banchan/detail/{itemId}
4 리스트 - 메인 GET /banchan/main
5 리스트 - 국물 GET /banchan/soup
6 리스트 - 반찬 GET /banchan/side

POST

번호 구분 요청 메서드 URL
1 데이터추가 - 메인 POST /banchan/main
2 데이터추가 - 국물 POST /banchan/soup
3 데이터추가 - 반찬 POST /banchan/side
4 데이터추가 - 베스트 POST /banchan/best

2. Response 포맷

1. 리스트 메인요리 GET >> /banchan/best

[{
	"category_id": 4,
	"name": "할인특가 세트상품",
	"items": [{
		"id": 2,
		"topImage": "https://cdn.bmf.kr/_data/product/201410/13/b8b0a0aba3386f030155b6cb0c1c75fa.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "[사계절]편리한 반찬세트 - 사계절 건강식당 작은상",
		"description": "마포엄마들이 사랑해온 건강반찬 사계절 건강식",
		"normalPrice": 23500,
		"salePrice": 19900,
		"badges": "EVENT, LAUNCHING"
	}, {
		"id": 1,
		"topImage": "https://cdn.bmf.kr/_data/product/H206E/325c7aeb1673ffe58052463d93e407b8.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "[아내가쉐프했다]풍성한 고기반찬 찜닭요리",
		"description": "아내의쉐프가 자신 있게 만들어서 이름도 아쉐찜닭",
		"normalPrice": 10900,
		"salePrice": 9900,
		"badges": "EVENT, LAUNCHING"
	}]
}, {
	"category_id": 5,
	"name": "풍성한 고기반찬",
	"items": [{
		"id": 3,
		"topImage": "https://cdn.bmf.kr/_data/product/H05FB/6ff744c6f36ba437a4f8b9e9a000b0b1.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "[옹가솜씨] 소고기쩜짜장 280g",
		"description": "옹가솜씨 한국인의 쏘울푸드 쩜짜장 짱맛있다!",
		"normalPrice": 20000,
		"salePrice": 14900,
		"badges": "EVENT, LAUNCHING"
	}]
}, {
	"category_id": 6,
	"name": "편리한 반찬세트",
	"items": [{
		"id": 4,
		"topImage": "https://cdn.bmf.kr/_data/product/HBDEF/289b0fb6c14d2c8cd161205f8dadfa7a.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "미노리키친] 규동 250g",
		"description": "전세계인의 소울프도 한국인들도 좋아하는 소고기덮밥",
		"normalPrice": 98000,
		"salePrice": 76600,
		"badges": "EVENT, LAUNCHING"
	}]
}]

2. 리스트 베스트 카테고리 GET >> /banchan/best/{categoryId}

http://13.125.229.168:8080/banchan/best/1

{
	"category_id": 1,
	"name": "MAIN",
	"items": [{
		"id": 5,
		"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/HBDEF/70b0c77d3ef5cdd6269588685bbefe43.jpg",
		"deliveryTypes": "DOMESTIC_POST",
		"title": "[신논현 맛집]돼지국밥맛집",
		"description": "종가집 1000년전통 돼지고기로 만든 순대!!",
		"normalPrice": 10000,
		"salePrice": 9000,
		"badges": "EVENT, LAUNCHING"
	}, {
		"id": 6,
		"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/HBDEF/9c2c53b40a11b79c90549a058c2da4b7.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "[미노리키친] 규동 250g",
		"description": "일본인의 소울푸드! 한국인도 좋아하는 소고기덮밥",
		"normalPrice": 6500,
		"salePrice": 7000,
		"badges": "EVENT"
	}, {
		"id": 7,
		"topImage": "http://public.codesquad.kr/jk/storeapp/data/2455226945d52f5aefd51f35d663bb16.jpg",
		"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
		"title": "[마샐미디쉬] 매콤마늘쫑 해산물볶음 180g",
		"description": "탱글탱글한 새우와 오징어를 마늘쫑과 함께 매콤하게 볶아냈어요.",
		"normalPrice": 38000,
		"salePrice": 27000,
		"badges": "EVENT, LAUNCHING"
	}]
}

3. 상세보기 id로 상세보기 GET >> /banchan/detail/{itemId}

http://13.125.229.168:8080/banchan/detail/1

{
	"id": 1,
	"topImage": "https://cdn.bmf.kr/_data/product/H206E/325c7aeb1673ffe58052463d93e407b8.jpg",
	"thumbImages": ["https://cdn.bmf.kr/_data/product/H206E/325c7aeb1673ffe58052463d93e407b8.jpg"],
	"description": "아내의쉐프가 자신 있게 만들어서 이름도 아쉐찜닭",
	"deliveryInfo": "DOMESTIC_POST, NEXT_DAY",
	"deliveryFee": "2,500원 (40,000원 이상 구매 시 무료)",
	"normalPrice": 10900,
	"salePrice": 9900,
	"point": 99
}

4. 리스트 메인 GET >> /banchan/main

http://13.125.229.168:8080/banchan/main

[{
	"id": 5,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/HBDEF/70b0c77d3ef5cdd6269588685bbefe43.jpg",
	"deliveryTypes": "DOMESTIC_POST",
	"title": "[신논현 맛집]돼지국밥맛집",
	"description": "종가집 1000년전통 돼지고기로 만든 순대!!",
	"normalPrice": 10000,
	"salePrice": 9000,
	"badges": "EVENT, LAUNCHING"
}, {
	"id": 6,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/HBDEF/9c2c53b40a11b79c90549a058c2da4b7.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[미노리키친] 규동 250g",
	"description": "일본인의 소울푸드! 한국인도 좋아하는 소고기덮밥",
	"normalPrice": 6500,
	"salePrice": 7000,
	"badges": "EVENT"
}, {
	"id": 7,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/2455226945d52f5aefd51f35d663bb16.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[마샐미디쉬] 매콤마늘쫑 해산물볶음 180g",
	"description": "탱글탱글한 새우와 오징어를 마늘쫑과 함께 매콤하게 볶아냈어요.",
	"normalPrice": 38000,
	"salePrice": 27000,
	"badges": "EVENT, LAUNCHING"
}]

5. 리스트 국물 GET >> /banchan/soup

[{
	"id": 11,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/H26C7/3d67aabd2751620367e1d1ac3e3d7ef2.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[모이세] 육개장 1팩(600g)",
	"description": "제주3대해장국 맛집의 인기메뉴",
	"normalPrice": 5900,
	"salePrice": 4400,
	"badges": "LAUNCHING"
}, {
	"id": 12,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/H0FC6/341b8605fa224ec1808c4f169097d170.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[수하동] 특곰탕 850g]",
	"description": "100% 한우양지로 끓여낸 70년전통의 서울식곰탕",
	"normalPrice": 19900,
	"salePrice": 18000,
	"badges": "EVENT, LAUNCHING"
}, {
	"id": 13,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/c069bc32cb37727c59e1f0c2839311a0.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[빅마마의밥친구] 된장찌개 900g",
	"description": "항아리에서 숙성시킨 집된장으로만 맛을내 짜지 않은 된장찌개",
	"normalPrice": 10000,
	"salePrice": 8500,
	"badges": "EVENT, LAUNCHING"
}, {
	"id": 14,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/H26C7/2ad963a9f63d371826748c852a0025c3.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[모이세] 육개장 1팩(600g)",
	"description": "제주3대해장국 맛집의 인기메뉴",
	"normalPrice": 5900,
	"salePrice": 4400,
	"badges": "EVENT, LAUNCHING"
}]

6. 리스트 반찬 GET >> /banchan/side

[{
	"id": 8,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/HDF73/9bd9158fb5ffbc46708b7928ee50708e.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[빅마마의밥친구] 아삭 고소한 연근고기조림 250g",
	"description": "편식하는 아이도 좋아하는 건강연근조림",
	"normalPrice": 5500,
	"salePrice": 5500,
	"badges": "EVENT, LAUNCHING"
}, {
	"id": 9,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/H602F/670e7deefe1d84a4f4e058655fbd4d7c.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[미노리키친] 일본식 우엉조림(킨피라고보) 80g",
	"description": "한국식 우엉조림과는 다른 진한 감칠맛",
	"normalPrice": 3300,
	"salePrice": 3500,
	"badges": "EVENT, LAUNCHING"
}, {
	"id": 10,
	"topImage": "http://public.codesquad.kr/jk/storeapp/data/detail/H0FC6/341b8605fa224ec1808c4f169097d170.jpg",
	"deliveryTypes": "DOMESTIC_POST, NEXT_DAY",
	"title": "[마더앤찬] 명란치즈계란말이 230g",
	"description": "아이반찬으로 최고 계란말이",
	"normalPrice": 3780,
	"salePrice": 3779,
	"badges": "EVENT, LAUNCHING"
}]
Clone this wiki locally