Label API

• 전체 Label 목록 ⭕
• 생성 ⭕
• 삭제 ⭕
• 수정 ⭕

전체 Label 목록

Method	Endpoint
GET	/labels

• responses
  • 성공

    res.status(200).json({
      success: true,
      data: [{
          id: <label_id>,
          name: <label_name>,
          descriprtion: <label_description>,
          color: <label_color>,
      }, {...},
      ]
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

생성

Method	Endpoint
POST	/labels

• body

  {
      "name": "<label_name>",
      "description": "<labe_description>",
      "color": "<label_color>",
  }

• responses

  • 성공

    res.status(201).json({
      success: true,
      data: {
        id: <label_id>
      }
    })

  • 잘못된 요청

    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

삭제 ⭕

Method	Endpoint
DELETE	/labels/:id

• responses

  • 성공

    res.status(200).json({
      success: true
    })

  • 잘못된 요청

    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

수정 ⭕

Method	Endpoint
PATCH	/labels/:id

• body

  {
      "name?": "<label_name>",
      "description?": "<label_description>",
      "color?": "<label_color>",
  }

• responses

  • 성공

    res.status(200).json({
      success: true,
    })

  • 잘못된 요청

    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })