Skip to content

API 명세서 4. Comment

Sooyeon Park edited this page Nov 12, 2020 · 4 revisions

이슈에 대한 코멘트 목록 조회

GET /api/issue/{issueId}/comment
  • Response Status code
code 설명
200 정상적으로 생성
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
404 해당 id를 갖는 이슈가 존재하지 않을 때
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
    "data": [
        {
            "id": Number,
            "content": String,
            "user": {
                "id": Number,
                "avatar": String,
                "username": String
            },
            "createdAt": timestamp,
            "updatedAt": timestamp
        }
    ]
}

코멘트 생성

POST /api/issue/{issueId}/comment
  • Request
{
    "content": String (required)
}
  • Response Status code
code 설명
200 정상적으로 생성
400 request body가 정상적이지 않은 경우
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
}

코멘트 수정

PUT /api/comment/{commentId}
  • Request
{
    "content": String (required)
}
  • Response Status code
code 설명
200 정상적으로 생성
400 request body가 정상적이지 않은 경우
401 헤더에 토큰을 실지 않는 경우 (로그인 X)
404 해당 아이디를 가지는 코멘트가 없는 경우
500 내부 서버 에러
  • Response
{
    "message": "The request is successfully processed"
}

코멘트 삭제

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