COMMENT API 문서

댓글 허용인 게시글에만 댓글 생성이 가능합니다.

요청

Request

POST /comments HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 77
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI3MSIsInJvbGVzIjoiUk9MRV_tmozsm5AiLCJpYXQiOjE3MTExMTkxMjgsImV4cCI6MTcxMTEyMjcyOH0.d3xWwYlE4LRGcm54gDxRuEr5bw2a9YPWovGnvxLyrTw

{
  "postId" : 6,
  "parentId" : 6,
  "content" : "테스트 댓글 내용"
}

Request Cookies

Name Description

Name	Description
`accessToken`	ACCESS TOKEN (ROLE_회원)

accessToken

ACCESS TOKEN (ROLE_회원)

Request Fields

필드명 타입 필수값 양식 설명

필드명	타입	필수값	설명
`postId`	`Number`	true	댓글을 달 게시글의 ID
`parentId`	`Number`		부모 댓글의 ID (대댓글이 아닌 경우 null)
`content`	`String`	true	댓글 내용

postId

Number

true

댓글을 달 게시글의 ID

parentId

Number

부모 댓글의 ID (대댓글이 아닌 경우 null)

content

String

true

댓글 내용

응답

Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: /comments/posts/6
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Response Headers

Name Description

Name	Description
`Location`	댓글 목록을 불러오는 URI 입니다.

Location

댓글 목록을 불러오는 URI 입니다.

댓글 목록 조회

요청

Request

GET /comments/posts/5 HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2OSIsInJvbGVzIjoiUk9MRV_tmozsm5AiLCJpYXQiOjE3MTExMTkxMjgsImV4cCI6MTcxMTEyMjcyOH0.5M5Rk7VVFZ-Wq_lgKEXyMVLHUarV61_JE5ElLtJe1a0

Request Cookies

Name Description

Name	Description
`accessToken`	ACCESS TOKEN (ROLE_회원)

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 1. /comments/posts/{postId}
Parameter	Description
`postId`	조회하고자 하는 댓글목록의 게시글 ID

응답

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 352

{
  "comments" : [ {
    "commentId" : 4,
    "writerId" : 69,
    "writerName" : "FsZmUUvsNp",
    "writerThumbnailPath" : null,
    "content" : "댓글내용",
    "registerTime" : "2024-03-22T14:52:09",
    "parentId" : null,
    "likeCount" : 0,
    "dislikeCount" : 0,
    "isLike" : false,
    "isDislike" : false,
    "isDeleted" : false
  } ]
}

Response Fields

Path Type Description

Path	Type	Description
`comments[].commentId`	`Number`	댓글 ID
`comments[].writerId`	`Number`	댓글 작성자 ID
`comments[].writerName`	`String`	댓글 작성자 이름
`comments[].writerThumbnailPath`	`Null`	댓글 작성자의 썸네일 경로
`comments[].content`	`String`	댓글 내용
`comments[].registerTime`	`String`	댓글 등록 시간
`comments[].parentId`	`Null`	부모 댓글 ID
`comments[].likeCount`	`Number`	댓글 좋아요 개수
`comments[].dislikeCount`	`Number`	댓글 싫어요 개수
`comments[].isLike`	`Boolean`	댓글 좋아요 했는지 여부
`comments[].isDislike`	`Boolean`	댓글 싫어요 했는지 여부
`comments[].isDeleted`	`Boolean`	댓글 삭제 여부

comments[].commentId

Number

댓글 ID

comments[].writerId

Number

댓글 작성자 ID

comments[].writerName

String

댓글 작성자 이름

comments[].writerThumbnailPath

Null

댓글 작성자의 썸네일 경로

comments[].content

String

댓글 내용

comments[].registerTime

String

댓글 등록 시간

comments[].parentId

Null

부모 댓글 ID

comments[].likeCount

Number

댓글 좋아요 개수

comments[].dislikeCount

Number

댓글 싫어요 개수

comments[].isLike

Boolean

댓글 좋아요 했는지 여부

comments[].isDislike

Boolean

댓글 싫어요 했는지 여부

comments[].isDeleted

Boolean

댓글 삭제 여부

댓글 삭제

요청

Request

DELETE /comments/3 HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NyIsInJvbGVzIjoiUk9MRV_tmozsm5AiLCJpYXQiOjE3MTExMTkxMjgsImV4cCI6MTcxMTEyMjcyOH0.OuaZdPqnjUkl-tr8ozb8YnxpkgKPq8pIowR0Vwqm3O4

Request Cookies

Name Description

Name	Description
`accessToken`	ACCESS TOKEN (ROLE_회원)

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 2. /comments/{commentId}
Parameter	Description
`commentId`	삭제하고자 하는 댓글의 ID

응답

Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

댓글 좋아요 또는 좋아요 취소

요청

Request

PATCH /comments/2/likes HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2NSIsInJvbGVzIjoiUk9MRV_tmozsm5AiLCJpYXQiOjE3MTExMTkxMjgsImV4cCI6MTcxMTEyMjcyOH0.ox-PLnlXm_D5HxvWOJISi_c5S678GzW-vccT411RijM

Request Cookies

Name Description

Name	Description
`accessToken`	ACCESS TOKEN (ROLE_회원)

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 3. /comments/{commentId}/likes
Parameter	Description
`commentId`	좋아요 또는 좋아요 취소하고자 하는 댓글의 ID

응답

Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

댓글 싫어요 또는 싫어요 취소

요청

Request

PATCH /comments/1/dislikes HTTP/1.1
Host: docs.api.com
Cookie: accessToken=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2MyIsInJvbGVzIjoiUk9MRV_tmozsm5AiLCJpYXQiOjE3MTExMTkxMjgsImV4cCI6MTcxMTEyMjcyOH0.n-AbCuUWGfYu8H_Errxc-ltLQLdRoKWjNGKVj70zwHE

Request Cookies

Name Description

Name	Description
`accessToken`	ACCESS TOKEN (ROLE_회원)

accessToken

ACCESS TOKEN (ROLE_회원)

Path Parameters

Table 4. /comments/{commentId}/dislikes
Parameter	Description
`commentId`	싫어요 또는 싫어요 취소하고자 하는 댓글의 ID

응답

Response

HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY