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] SpringDoc 수정 #90

Merged
merged 3 commits into from
Mar 22, 2024
Merged

[Refactor] SpringDoc 수정 #90

merged 3 commits into from
Mar 22, 2024

Conversation

Jeongmin39
Copy link
Contributor

✨ PR 유형

어떤 변경 사항이 있나요??

  • 새로운 기능 추가
  • 버그 수정
  • CSS 등 사용자 UI 디자인 변경
  • 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
  • 코드 리팩토링
  • 주석 추가 및 수정
  • 문서 수정
  • 테스트 추가, 테스트 리팩토링
  • 빌드 부분 혹은 패키지 매니저 수정
  • 파일 혹은 폴더명 수정
  • 파일 혹은 폴더 삭제

🛠️ 작업내용

Swagger 내용 보충을 위해 주석을 추가하였습니다.
응답형식을 ResponseEntity에서 ApiResponse로 수정할 예정이므로 이를 반영하였습니다.

📋 추후 진행 상황

응답코드 틀이 수정되면 관련 내용을 추가할 예정입니다.
@ApiResponse를 이용해 각 응답코드에 대한 설명을 추가하고 그 후 머지할 예정입니다.

📌 리뷰 포인트

아직 주석 부분밖에 추가되지 않았습니다. 응답코드 틀 수정 후 관련 코드 추가하겠습니다.
@ApiResponses 어노테이션은 다중 응답, 즉 여러 상태 코드에 대한 응답에 대해 설명을 제공할 때 사용된다고 합니다.
@operation 어노테이션의 responses 속성보다 @ApiResponses 어노테이션이 적절하다고 생각하여 사용하였는데 다들 어떻게 생각하시는지 궁금합니다 !

✅ Checklist

PR이 다음 요구 사항을 충족하는지 확인해주세요

  • 커밋 메시지 컨벤션에 맞게 작성했습니다
  • 유지-보수를 위해 주석 처리를 잘 작성했습니다

@Jeongmin39 Jeongmin39 self-assigned this Mar 6, 2024
@Jeongmin39 Jeongmin39 added 🚶‍♀️정민 정민이 담당 ⚒️ refactor 리팩토링 labels Mar 6, 2024
Copy link
Member

@arinming arinming left a comment

Choose a reason for hiding this comment

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

확인했습니다!

@choeun7 choeun7 merged commit ed27ded into dev Mar 22, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚒️ refactor 리팩토링 🚶‍♀️정민 정민이 담당
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants