Skip to content

리뷰_댓글_목록_조회

whale0928 edited this page Jul 6, 2024 · 2 revisions

개요

  • 작성일: 2024-07-06
  • 리뷰의 댓글 목록을 조회하는 API에 대한 테크스펙을 정의합니다.

요구사항 정의

  • 리뷰에 댓글을 조회할 수 있다.
  • 이 때 해당 api에서는 최상위 댓글 목록만 제공된다.
  • 댓글 목록은 크게 2가지로 구성된다 최상위 댓글 목록 , 대댓글 목록
    • 최상위 댓글 목록 : 리뷰에 대한 댓글 중 최상위 댓글 목록 기본적으로 노출되는 댓글 목록
    • 대댓글 목록 : 최상위 댓글에 대한 대댓글 목록 , 계층별로 대댓글이 다시 대댓들이 존재할 수 있다. 다만 제공되는 형태는 하나의 최상위 댓글에 대한 대댓글 목록만 제공된다.
  • 댓글은 최신순으로만 정렬된다.
  • 댓글은 한번에 50개씩 제공된다. 이때 댓글이 50개 이상인 경우 다음 페이지를 요청할 수 있다. (커서 페이지네이션)
  • 대댓글 목록은 별도의 api로 제공된다.

용어 사전

한글명 영문명 설명
리뷰 Review 사용자가 작성한 리뷰
댓글 Comment 사용자가 작성한 리뷰에 대한 댓글
최상위 댓글 Root Reply 리뷰에 대한 댓글 중 최상위 댓글
상위 댓글 Parent Reply 댓글에대한 바로 상위 댓글

요청시에는 뭐가 있어야 할까.

  • 조회할 리뷰의 식별자
  • 페이지 정보
    • 이떄 정렬 조건은 최신순 고정이기 때문에 페이지 정보만 있으면 된다.

응답 시에는 뭐가 있어야 할까.

  • 댓글 목록
  • 최상위 댓글 목록
    • 작성자 식별자
    • 작성자 프로필 이미지.
    • 작성자 닉네임
    • 작성일
    • 댓글 내용
    • 대댓글 목록 수

어떤 걸 검증해야할까.

  • 리뷰 식별자가 유효한지.
  • 페이지 정보가 유효한지.
  • 댓글 목록이 최신순으로 정렬되어 있는지.
  • 한번에 댓글 목록이 50개 이하인지.
  • 최상위 댓글 목록에 대댓글 목록이 존재하는지.

추가적인 참고 요소는?

Clone this wiki locally