Skip to content

Comment

Jaeyu Jo edited this page Jan 11, 2019 · 12 revisions

Comment

댓글 조회

메소드 경로 설명
GET /comments/contents/{contentIdx} 해당 게시글 모든 댓글 조회
Parameters
필드 타입 필수여부 설명
contentIdx int Required 게시글 고유 번호

요청헤더

Authorization: token

응답 바디

모든 댓글 조회 성공

{
    "status": 200,
    "message": "댓글 조회 성공",
    "data": [
        {
            "commentIdx": 4,
            "content": "댓글내용2",
            "createdAt": "2019-01-11T18:29:04",
            "contentIdx": 2,
            "userIdx": 2,
            "userName": "김민서억",
            "userProfile": "https://s3.ap-northeast-2.amazonaws.com/resized/origin/747a62256e144335ad5bf33a38e7a3df.jpg"
        },
        {
            "commentIdx": 7,
            "content": "ㅎㅇ",
            "createdAt": "2019-01-11T18:36:05",
            "contentIdx": 2,
            "userIdx": 12,
            "userName": "재휘",
            "userProfile": null
        },
        {
            "commentIdx": 8,
            "content": "ㅎㅇ",
            "createdAt": "2019-01-11T18:40:48",
            "contentIdx": 2,
            "userIdx": 12,
            "userName": "재휘",
            "userProfile": null
        },
        {
            "commentIdx": 9,
            "content": "ㅎㅇㅎㅇㅎ",
            "createdAt": "2019-01-11T18:41:13",
            "contentIdx": 2,
            "userIdx": 12,
            "userName": "재휘",
            "userProfile": null
        },
        {
            "commentIdx": 11,
            "content": "댓글",
            "createdAt": "2019-01-11T18:45:08",
            "contentIdx": 2,
            "userIdx": 12,
            "userName": "재휘",
            "userProfile": null
        }
    ]
}
Parameters
필드 타입 필수여부 설명
commentIdx int Required 댓글 고유 번호
content String Required 댓글 내용
createdDate LocalDateTime Required 댓글 입력 시간
contentIdx int Required 게시글 고유 번호
userIdx int Required 회원 고유 번호
userName String Required 회원 닉네임
userProfile String Required 회원 프로필URL

댓글이 존재하지 않음

{
    "status": 204,
    "message": "댓글을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

이번주 댓글 수 조회

메소드 경로 설명
GET /comments/count/week 이번 주 댓글 수 조회

요청헤더

Authorization: token

응답 바디

이번주 댓글 수 조회 성공

{
    "status": 200,
    "message": "댓글 조회 성공",
    "data": {
        "count": 1
    }
}

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

댓글 등록

메소드 경로 설명
POST /comments/contents/{contentIdx} 댓글 등록
Parameters
필드 타입 필수여부 설명
contentIdx int Required 게시글 고유 번호

요청헤더

Authorization: token
Content-Type :application/json

요청 바디

{
    "content": "내용"
}
Parameters
필드 타입 필수여부 설명
content String Required 댓글 내용

응답 바디

댓글 등록 성공

{
    "status": 201,
    "message": "댓글 등록 성공",
    "data": null
}

존재하지 않는 게시글

{
    "status": 404,
    "message": "게시글을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

댓글 수정

메소드 경로 설명
PUT /comments/{commentIdx} 댓글 수정
Parameters
필드 타입 필수여부 설명
commentIdx int Required 댓글 고유 번호

요청헤더

Authorization: token
Content-Type :application/json

요청 바디

{
    "content": "내용"
}
Parameters
필드 타입 필수여부 설명
content String Required 댓글 수정 내용(전문)

응답 바디

댓글 수정 성공

{
    "status": 200,
    "message": "댓글 수정 성공",
    "data": null
}

존재하지 않는 댓글

{
    "status": 404,
    "message": "댓글을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

댓글 삭제

메소드 경로 설명
DELTE /comments/{commentIdx} 댓글 삭제
Parameters
필드 타입 필수여부 설명
commentIdx int Required 댓글 고유 번호

요청헤더

Authorization: token

응답 바디

댓글 삭제 성공

{
    "status": 200,
    "message": "댓글 삭제 성공",
    "data": null
}

존재하지 않는 댓글

{
    "status": 404,
    "message": "댓글을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}