API_Comment - Laterality/yummy-dishes-REST GitHub Wiki

Index

리뷰 등록

새 리뷰를 등록합니다.

  • URL

    /comment/register

  • Method:

    POST

  • URL Params

None

  • Data Params
author
string
리뷰를 작성한 사용자의 "_id" 필드값
product
string
리뷰 대상 제품의 "_id" 필드값
rate
integer
평점(1~5)
tastes
Array<string>
사용자가 선택한 Tastes의 "_id" 배열
content
리뷰 내용
text
string
리뷰의 텍스트 내용
images
Array<string>
첨부 이미지의 "_id" 필드값 배열

  • Success Response:

    • Code: 201
      Content:

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

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    {
  		"author": "...",
  		"product": "...",
  		"rate": 3,
  		"tastes": [ ... ],
  		"content": {
  			"text": "comment text content",
  			"images": [],
  		}

  • Notes:


답글 등록

리뷰에 대한 답글을 등록합니다.

  • URL

    /comment/{commentId}/reply

  • Method:

    POST

  • URL Params

    commentId
    string
    답글을 등록할 리뷰의 "_id"필드값

  • Data Params

    author
    string
    답글을 작성한 사용자의 "_id" 필드값
    content
    string
    답글 내용

  • Success Response:

    • Code: 201
      Content:

      { 
	"result": "ok",
	"comment": {
		...
	}
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지
      comment
      CommenttModel
      요청이 성공한 경우 생성된 리뷰

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    {
  "author": "...",
  "content": "reply content",
  ...
}

  • Notes:


리뷰 조회

리뷰의 _id로 단일 리뷰를 조회합니다.

  • URL

    /comment/{commentId}

  • Method:

    GET

  • URL Params

    commentId
    string
    조회 할 리뷰의 "_id" 필드값
    q
    string
    반환받을 필드명
    ["author", "product", "date_reg", "rate", "tastes", "content", "reply"]

  • Data Params

    None

  • Success Response:

    • Code: 200
      Content:

      { 
	"result": "ok",
	"comment": {
		...
	}
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지
      comment
      CommentModel
      요청이 성공한 경우 조회된 리뷰

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    GET /comment/59bd562d61c8fa3ce8ccf4eb?q=author,product,date_reg

  • Notes:


리뷰 갱신

기존 리뷰를 갱신합니다.

  • URL

    /comment/{commentId}/update

  • Method:

    PUT

  • URL Params

    Required:

    commentId
    string
    갱신할 리뷰의 "_id" 필드 값

  • Data Params

    rate
    integer
    평점(1~5)
    content
    리뷰 내용
    text
    string
    리뷰 텍스트
    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"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    PUT /product/599297a54a03b51a11aa3d27/update
{
    rate: 5,
    content: {
  	  text: "changed content",
  	  images: []
    }
}

  • Notes:


리뷰 제거

리뷰를 제거합니다.

  • URL

    /comment/{commentId}/delete

  • Method:

    DELETE

  • URL Params

    Required:

    commentId
    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"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    # _id필드값이 599297a54a03b51a11aa3d27인 리뷰를 삭제
DELETE /product/599297a54a03b51a11aa3d27/delete

  • Notes:

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