API_Taste - Laterality/yummy-dishes-REST GitHub Wiki

---

Index

• 맛 등록
• 맛 조회
• 맛 전체 조회
• 맛 갱신
• 맛 제거

---

---

맛을 등록합니다.

• URL

  /taste/register

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  title

  string

  표시될 텍스트

• Success Response:

  • Code: 201
    Content:

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

    result

    string

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

    message

    string

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

    taste

    TasteModel

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

• Error Response:

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  {
    "title": "Salty"
  }
  

• Notes:

  none

---

맛을 조회하는 API입니다.

• URL

  /taste/{tasteId}

• Method:

  GET

• URL Params

  Required:

  tasteId

  string

  맛의 "_id" 필드값

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

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

    result

    string

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

    message

    string

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

    taste

    TasteModel

    조회된 맛

• Error Response:

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  GET /taste/599297a54a03b51a11aa3d27
  

• Notes:

  None

---

생성된 전체 맛을 조회합니다.

• URL

  /taste/tastes

• Method:

  GET

• URL Params

  None

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"tastes": [
    		...
    	]
    }
    

    result

    string

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

    message

    string

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

    tastes

    TasteModel

• Error Response:

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  GET /taste/tastes
  

• Notes:

  None

---

생성된 맛을 갱신합니다.

• URL

  /taste/{tasteId}/update

• Method:

  PUT

• URL Params

  Required:
  

  tasteId

  string

  맛의 "_id" 필드

• Data Params

  Body

  title
  string
  수정될 텍스트

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

  {
    "title": "Changed Title"
  }
  

• Notes:

  None

---

생성된 맛을 제거합니다.

• URL

  /taste/{tasteId}/delete

• Method:

  DELETE

• URL Params

  Required:
  

  tasteId

  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:

  DELETE /taste/599a5eb80abb413e0a7abff4/delete
  

• Notes:

  none