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

[Refactor/147] 게시판, 매너평가 관련 코드 리팩토링 #148

Merged
merged 3 commits into from
Aug 10, 2024

Conversation

hzee97
Copy link
Contributor

@hzee97 hzee97 commented Aug 10, 2024

🚀 개요

게시판, 매너평가 관련 코드 리팩토링

🔍 변경사항

  • 게시판 : tier 자료형 string에서 enum 으로 변경
  • 게시판 글 목록 조회 API Swagger 명세
  • 매너평가 : 코드 리팩토링

⏳ 작업 내용

  • 게시판 : tier 자료형 string에서 enum 으로 변경.
  • 게시판 글 목록 조회 API Swagger 명세.
  • 매너평가 : response 에 @Setter 삭제.

📝 논의사항

@hzee97 hzee97 requested review from rimi3226 and Eunjin3395 August 10, 2024 15:57
@hzee97 hzee97 self-assigned this Aug 10, 2024
@hzee97 hzee97 linked an issue Aug 10, 2024 that may be closed by this pull request
2 tasks
Copy link
Member

@Eunjin3395 Eunjin3395 left a comment

Choose a reason for hiding this comment

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

고생하셨습니다!

@@ -116,7 +117,7 @@ public ApiResponse<String> delete(@PathVariable Long postId
@Parameter(name = "pageIdx", description = "조회할 페이지 번호를 입력해주세요. 페이지 당 20개의 게시물을 볼 수 있습니다.")
Copy link
Member

Choose a reason for hiding this comment

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

혹시 여기에 mode,mainPosition에 대한 파라미터 설명도 적어주실 수 있나요?!

Suggested change
@Parameter(name = "pageIdx", description = "조회할 페이지 번호를 입력해주세요. 페이지 당 20개의 게시물을 볼 수 있습니다.")
@Parameters({
@Parameter(name = "cursor", description = "페이징을 위한 커서, Long 타입 notificationId를 보내주세요. 보내지 않으면 가장 최근 알림 10개를 조회합니다."),
@Parameter(name = "type", description = "알림 타입 조회 필터, general 또는 friend를 입력해주세요.")
})

이런 식으로 파라미터 여러개에 대한 swagger 설명 추가가 가능합니다..!

@hzee97 hzee97 merged commit 8c98a74 into develop Aug 10, 2024
@hzee97 hzee97 deleted the refactor/147 branch August 10, 2024 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

♻️ [Refactor] 게시판, 매너평가 관련 코드 리팩토링
2 participants