API_Coupon - Laterality/yummy-dishes-REST GitHub Wiki

---

Index

• 쿠폰 등록
• 쿠폰 조회
• 쿠폰 사용
• 쿠폰 제거

---

---

쿠폰을 등록하는 API입니다.

• URL

  /coupon/register

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  message

  string

  쿠폰 설명

  owner

  string

  쿠폰 소유자의 "_id" 필드값

• Success Response:

  • Code: 201
    Content:

    { 
    	"result": "ok",
    	"coupon": {
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    coupon

    CouponModel

    요청이 성공한 경우 생성된 쿠폰 정보

• Error Response:

  • Code: 405 INVALID PARAMETERS
    Content:

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

  OR

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  {
    "message": "15% D/C during the time sale",
    "owner": "..."
  }
  

• Notes:

  none

---

쿠폰 번호로 쿠폰을 조회합니다.

• URL

  /coupon/by-coupon-number

• Method:

  GET

• URL Params

  Required:

  cn

  string

  쿠폰 번호

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"coupon": {
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    coupon

    CouponModel

    조회된 쿠폰

• Error Response:

  • Code: 404 NOT FOUND
    Content:

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

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  GET /coupon/by-coupon-number?cn=1234-5678-9876
  

• Notes:

  None

---

쿠폰을 사용합니다.

• URL

  /coupon/consume

• Method:

  GET

• URL Params

  Required:
  

  cn

  string

  쿠폰 번호

• 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:

  GET /coupon/consume?cn=1234-5678-9876
  

• Notes:

  None

---

쿠폰을 제거합니다.

• URL

  /coupon/delete

• Method:

  DELETE

• URL Params

  Required:
  

  cn

  string

  쿠폰 번호

• 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: 405 INVALID PARAMETERS Content:

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

  OR

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  DELETE /coupon/delete?cn=1234-5678-9876
  

• Notes:

  none