Skip to content

API 명세서 2. Label

SaetByeol Ahn edited this page Oct 28, 2020 · 4 revisions

레이블 목록 조회

GET /api/label
  • Response Status code
code 설명
200 정상적으로 생성
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
    "data": [
        {
            "id": Number,
            "title": String,
            "discription": String,
            "color": String,
        }
    ]
}

레이블 생성

POST /api/label
  • Request
{
    "title": String (required),
    "description": String,
    "color": String (required),
}
  • Response Status code
code 설명
200 정상적으로 생성
400 request body가 정상적이지 않은 경우 (타이틀/컬러 필드는 필수)
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
}

레이블 갱신

PUT /api/label/{labelId}
  • Request
{
    "title": String (required),
    "description": String,
    "color": String (required),
}
  • Response Status code
code 설명
200 정상적으로 갱신
400 request body가 정상적이지 않은 경우 (타이틀/컬러 필드는 필수)
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
}

레이블 삭제

DELETE /api/label/{labelId}
  • Response Status code
code 설명
200 정상적으로 삭제
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
404 해당 id를 가지는 레이블이 존재하지 않는 경우
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
}

Clone this wiki locally