API_Product - Laterality/yummy-dishes-REST GitHub Wiki

Index

제품 등록
제품 조회
제품 갱신
제품 제거
제품 검색
리뷰 조회

제품 등록

제품 정보를 등록하는 API입니다.

URL

/product/register
Method:

POST
URL Params

none
Data Params

Body

name

string

제품명

price

integer

제품 가격

amount

string

제품 분량

ingredient

string

제품 재료

contents

Array<string>

본문 내용

category

string

카테고리의 "_id" 필드

image_ids

Array<string>

업로드된 이미지의 "_id" 필드값 배열
Success Response:
- Code: 201
  Content:
```
{ 
	"result": "ok",
	"product": {
		...
	}
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지
  
  product
  
  ProductModel
  
  요청이 성공한 경우 생성된 제품 정보

Error Response:

Code: 405 INVALID PARAMETERS
Content:

{
	"result": "fail",
	"message": "invalid parameters"
}

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

{
  "name": "Product1",
  "price": 3000,
  "amount": "2인분 (600g)",
  "ingredient": "ing1, ing2, ...",
  "contents": [
  	"content1...",
  	"content2...",
  	...
  ]
  "category": "5993cce589d47e657b885ba3",
  "image_ids": [
  	"5993cce589d47e657b885ba3",
  	...
  ]
}

Notes:
- API상으로는 이미지 파일 업로드 개수에 제한이 없습니다. 필요한 경우 프론트엔드에서 제어해주세요.

제품 조회

제품 정보를 조회하는 API입니다.

URL

/product/{productId}
Method:

GET
URL Params

Reqired:

productId

string

제품 "_id" 필드 값

q

string

요청하는 정보 (,로 구분)

["amount", "ingredient", "contents", "category", "date_reg", "cnt_like", "avg_rate", "images"]
Data Params

None
Success Response:
- Code: 200
  Content:
```
{ 
	"result": "ok",
	"product": {
		...
	}
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지
  
  product
  
  ProductModel
  
  요청이 성공한 경우 제품 정보

Error Response:

Code: 404 NOT FOUND
Content:

{
	"result": "fail",
	"message": "not found"
}

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

# _id필드값이 599297a54a03b51a11aa3d27인 제품의 평균 평점과 이미지를 반환
GET /product/599297a54a03b51a11aa3d27?q=cnt_like,avg_rate,image

Notes:

제품 갱신

제품 정보를 갱신하는 API입니다.

URL

/product/{productId}/update
Method:

PUT
URL Params

Reqired:

productId

string

제품 "_id" 필드 값
Data Params

name

string

제품명

price

integer

제품 가격

amount

string

제품 분량

ingredient

string

제품 재료

contents

Array<string>

제품 설명 본문

category

string

카테고리의 "_id"필드값

images

Array<string>

이미지 "_id"필드값 배열
Success Response:
- Code: 200
  Content:
```
{ 
	"result": "ok"
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지

Error Response:

Code: 404 NOT FOUND
Content:

{
	"result": "fail",
	"message": "not found"
}

Code: 405 INVALID PARAMETERS Content:

{
	"result": "fail",
	"message": "invalid parameter: productId"
}

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

{
    "name": "changedProdName2",
    "price": 4500
}

Notes:
- 입력값 유효성 검사 해주세요, 꼭!
- Request Body에는 변경할 항목만 있으면 됩니다. 변경사항 없는 항목은 빈 문자열 혹은 숫자 타입인 경우 0 미만의 값을 넣어주세요

제품 제거

제품 정보를 제거하는 API입니다.

URL

/product/{productId}/delete
Method:

DELETE
URL Params

Reqired:

productId

string

제품 "_id" 필드 값
Data Params

None
Success Response:
- Code: 200
  Content:
```
{ 
	"result": "ok"
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지

Error Response:

Code: 404 NOT FOUND
Content:

{
	"result": "fail",
	"message": "not found"
}

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

DELETE /product/599297a54a03b51a11aa3d27/delete

Notes:

제품 검색

제품명과 재료에 대해 특정 키워드로 검색하는 API입니다.

URL

/product/search
Method:

GET
URL Params

Optional:

keyword

string

검색할 키워드

sort

string

정렬 기준, ["name", "cnt_like", "avg_rate"] (기본값은 name)

category

string

검색할 카테고리의 "_id"필드 값

q

string

요청하는 정보 (,로 구분)

["amount", "ingredient", "contents", "category", "date_reg", "cnt_like", "avg_rate", "images"]
Data Params

None
Success Response:
- Code: 200
  Content:
```
{ 
	"result": "ok",
	"products": [
		{
			...
		},
		...
	]
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지
  
  products
  
  Array<ProductModel>
  
  요청이 성공한 경우 제품 정보 배열

Error Response:

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

GET /product/search?keyword=나물&q=cnt_like,avg_rate,image

Notes:

리뷰 조회

해당 제품에 대해 작성된 리뷰 리스트를 반환합니다.

URL

/product/{productId}/comments
Method:

GET
URL Params

Required:

productId

string

제품의 "_id" 필드값

Optional:

q

string

반환받을 필드

["author", "product", "date_reg", "rate", "tastes", "content", "reply"]
Data Params

None
Success Response:
- Code: 200
  Content:
```
{ 
	"result": "ok",
	"comments": [
		{
			...
		},
		{
			...
		},
		...
	]
}
```
  result
  
  string
  
  요청에 대한 처리 결과["ok", "fail", "error"]
  
  message
  
  string
  
  처리 결과에 대한 추가 메시지
  
  product
  
  CommentModel
  
  요청이 성공한 경우 제품의 리뷰 배열

Error Response:

Code: 404 NOT FOUND
Content:

{
	"result": "fail",
	"message": "not found"
}

Code: 500 SERVER FAULT
Content:

{
	"result": "error",
	"message": "server fault"
}

Sample Call:

# _id필드값이 599297a54a03b51a11aa3d27인 제품의 리뷰에서 작성자와 평점을 반환
GET /product/599297a54a03b51a11aa3d27?q=author,rate

Notes:

None

API_Product - Laterality/yummy-dishes-REST GitHub Wiki

제품 등록

제품 조회

제품 갱신

제품 제거

제품 검색

리뷰 조회

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️