Skip to content

Label API

Zin0_0 edited this page Nov 30, 2020 · 5 revisions

Label

Method URL Description
GET api/label label ์ „์ฒด ์กฐํšŒ
POST api/label label ์ƒ์„ฑ
PUT api/label/:labelId label ์ˆ˜์ •
DELETE api/label/:labelId label ์‚ญ์ œ

Label Get API

URL

GET /api/label

Response Description

Name Type Description
labels ARRAY ๋ผ๋ฒจ ๋ฐฐ์—ด
title STRING ๋ผ๋ฒจ ์ œ๋ชฉ
color STRING ๋ผ๋ฒจ ์ƒ‰์ƒ

Response

{
    labels:
    [
        {
            id: 1,
            title: '๋ผ๋ฒจ 1',
            color: '#FFFFFF'
        }
    ]
}

Label Post API

URL

POST /api/label

Request Description

Name Required Type Description
title REQUIRED STRING ์ƒ์„ฑํ•  ๋ผ๋ฒจ์˜ ์ œ๋ชฉ
color REQUIRED STRING ์ƒ์„ฑํ•  ๋ผ๋ฒจ์˜ ์ƒ‰์ƒ

Request

{
    title : '๋ผ๋ฒจ 1',
    color : '#FFFFFF',
}

Response Description

Name Type Description
message STRING ์ƒ์„ฑ์— ์„ฑ๊ณตํ–ˆ๋‹ค๋Š” ์˜๋ฏธ์˜ 'ok '

Response

{
    message : 'ok'
}

Label Put API

URL

PUT /api/label/labelId

Request Description

Name Required Type Description
labelId REQUIRED QUERY_STRING ์ˆ˜์ •ํ•  ๋ผ๋ฒจ์˜ UUID
title REQUIRED STRING ์ˆ˜์ •ํ•  ๋ผ๋ฒจ์˜ ์ œ๋ชฉ
color REQUIRED STRING ์ˆ˜์ •ํ•  ๋ผ๋ฒจ์˜ ์ƒ‰์ƒ

Request

{
    title : '๋ผ๋ฒจ 1',
    color : '#FFFFFF',
}

Response Description

Name Type Description
message STRING ์ˆ˜์ •์— ์„ฑ๊ณตํ–ˆ๋‹ค๋Š” ์˜๋ฏธ์˜ 'ok '

Response

{
    message : 'ok'
}

Label Delete API

URL

DELETE /api/label/:labelId

Request Description

Name Required Type Description
labelId REQUIRED QUERY_STRING ์‚ญ์ œํ•  ๋ผ๋ฒจ์˜ UUID

Response Description

Name Type Description
message STRING ์‚ญ์ œ์— ์„ฑ๊ณตํ–ˆ๋‹ค๋Š” ์˜๋ฏธ์˜ 'ok '

Response

    {
        message:' ok'
    }
Clone this wiki locally