Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BE] refactor: 리뷰 상세 조회 dto 개선 #847

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

Kimprodp
Copy link
Contributor

@Kimprodp Kimprodp commented Oct 12, 2024


🚀 어떤 기능을 구현했나요 ?

  • 리뷰 상세 조회 응답 dto에서 불필요한 부분을 제거했습니다.
  • 이전에 조회 로직 개선에 대해 연구하면서 발견했던 부분인데, QuestionAnswerResponse 이후 각 답변에 대한 내용이 text와 options 들로만 구성되도 괜찮다 생각합니다.
  • dto에 불필요한 뎁스가 많아질수록 개선이 힘들 것 같아요.

🔥 어떻게 해결했나요 ?

  • optionGroup에 있는 항목들을 전부 사용하지 않아 optionGroupReponse가 있는 자체가 불필요한 뎁스를 늘리는 것 같아 제거했습니다.
  • optionItemResponse 에서도 isChecked 부분을 고정으로 treu로 사용하고 있어 제거했습니다.

변경된 응답 예시

{
  "formId" : 1,
  "revieweeName" : "아루",
  "projectName" : "리뷰미",
  "createdAt" : "2024-08-01",
  "sections" : [ {
    "sectionId" : 1,
    "header" : "프로젝트 기간 동안, 아루의 강점이 드러났던 순간을 선택해주세요.",
    "reviews" : [ {
      "questionId" : 1,
      "required" : true,
      "questionType" : "CHECKBOX",
      "questionContents" : "프로젝트 기간 동안, 아루의 강점이 드러났던 순간을 선택해주세요.",
      "options" : [ {
        "optionId" : 1,
        "content" : "커뮤니케이션, 협업 능력 (ex: 팀원간의 원활한 정보 공유, 명확한 의사소통)"
      }, {
        "optionId" : 2,
        "content" : "문제 해결 능력 (ex: 프로젝트 중 만난 버그/오류를 분석하고 이를 해결하는 능력)"
      }, {
        "optionId" : 3,
        "content" : "시간 관리 능력 (ex: 일정과 마감 기한 준수, 업무의 우선 순위 분배)"
      } ],
      "answer" : null
    }, {
      "questionId" : 2,
      "required" : true,
      "questionType" : "TEXT",
      "questionContents" : "위에서 선택한 사항에 대해 조금 더 자세히 설명해주세요.",
      "options" : null,
      "answer" : "나산초의 답변"
    } ]
  } ]
}

📝 어떤 부분에 집중해서 리뷰해야 할까요?

  • 놓치고 있는 부분이 있는지 확인해주세요.

📚 참고 자료, 할 말

  • 해당 PR은 차주 프론트 협의 후 병합합니다~

Copy link

github-actions bot commented Oct 12, 2024

Test Results

146 tests  ±0   146 ✅ ±0   4s ⏱️ -1s
 55 suites ±0     0 💤 ±0 
 55 files   ±0     0 ❌ ±0 

Results for commit 14f6846. ± Comparison against base commit b6d03d1.

♻️ This comment has been updated with latest results.

@donghoony donghoony changed the title [BE] refacotr: 리뷰 상세 조회 dto 개선 [BE] refactor: 리뷰 상세 조회 dto 개선 Oct 12, 2024
Copy link
Contributor

@skylar1220 skylar1220 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

api문서가 바뀌는 것이니 프론트에게 잘 전달해야겠네요
덕분에 조회 로직에서 몇 줄 줄어든 것도 좋네요👏👏

Copy link
Contributor

@donghoony donghoony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 프론트 먼저 머지하고 진행합시다!

Copy link
Contributor

@nayonsoso nayonsoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

제안 드립니다🙋🏻‍♀️

1/ questions -> reviews
지금은 question 이라는 객체에 질문 내용과 응답 내용이 다 들어가 있어요.
질문과 응답을 담는 객체의 이름은 questions 보다 reviews 가 더 적절할 것 같아요

2/ (1번이 반영된다면) content -> questionContents or questionName
지금의 questions 가 reviews 로 바뀐다면
지금의 content 는 questionContent 또는 questionName로 바꿔서 "질문의 내용" 이라는 것을 드러내야 할 것 같아요.

@donghoony
Copy link
Contributor

필드 이름 바뀌면 확실하게 전달해야겠네요~

Copy link
Contributor

@nayonsoso nayonsoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

안녕하시렵니까 테드?👋 반영된 것 확인했습니다. 💯

그리고 api 문서의 완성도를 조금 더 높이자면,
API 문서에서 응답 데이터를
"하나의 섹션에 첫번째 카테고리 질문, 두번째 서술형 질문" 으로 내려주면 더 좋을 것 같아요~
api 문서에서 두가지 경우에 각각 응답이 어떻게 오는지 볼 수 있도록요!

Copy link
Contributor

@nayonsoso nayonsoso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

구구구구굳~ 수고했어요😊

@donghoony donghoony changed the base branch from develop-x to develop October 24, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

[BE] 리뷰 상세 조회 응답에 불필요한 속성들을 제거한다.
4 participants