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] 소셜로그인 > Swagger와 API 문서 간 정보 불일치 수정 #136

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

jsoonworld
Copy link
Contributor

📄 Work Description

  • 소셜 로그인, 토큰 재발급, 필터링 정보 생성, 회원가입 API에 대한 Swagger 주석 추가 및 설명 보완
  • API 문서와 Swagger 설명 간의 불일치 문제 해결

⚙️ ISSUE

📷 Screenshot

토큰 재발급 Before

스크린샷 2024-09-14 오전 8 56 40

토큰 재발급 After

스크린샷 2024-09-14 오전 8 55 48

소셜 로그인 Before

스크린샷 2024-09-14 오전 9 00 39

소셜 로그인 After

스크린샷 2024-09-14 오전 8 55 58

💬 To Reviewers

  • Swagger 설명과 API 문서 간의 차이를 중점적으로 봐주시면 감사하겠습니다. 추가로 필요한 설명이나 수정 사항이 있다면 코멘트 부탁드립니다.
  • 기존 방식에서는 name과 description 박스를 개별적으로 컨트롤할 수 없었습니다. 이러한 상황에서, 클라이언트가 박스 안의 값을 보고 더 쉽게 이해할 수 있도록 개선 방향을 잡았고, 그 결과 description에 'Example:'이 표시되더라도 example 값을 사용하였습니다.

🔗 Reference

-  각 API 메서드에 대해 Swagger 주석 추가
- `filter` API 및 `signUp` API 헤더 정보 설명 보완
@jsoonworld jsoonworld added ♻️ refactor 코드 리팩토링 ex) 형식변경 🦊장순🦊 labels Sep 14, 2024
@jsoonworld jsoonworld self-assigned this Sep 14, 2024
Copy link
Member

@JungYoonShin JungYoonShin 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

@junggyo1020 junggyo1020 left a comment

Choose a reason for hiding this comment

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

전보다 훨씬 명확하고 좋네요!!! 고생하셨습니다:)

@junggyo1020 junggyo1020 merged commit 0eddd35 into develop Sep 19, 2024
1 check passed
@jsoonworld jsoonworld deleted the refactor/#134 branch October 10, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
♻️ refactor 코드 리팩토링 ex) 형식변경 🦊장순🦊
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants