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

docs: 애플 로그인 API 문서화 #954

Merged
merged 4 commits into from
Jan 15, 2025
Merged

docs: 애플 로그인 API 문서화 #954

merged 4 commits into from
Jan 15, 2025

Conversation

mzeong
Copy link
Member

@mzeong mzeong commented Jan 14, 2025

🚩 연관 이슈

close #950


📝 작업 내용

POST /v1/auth/apple

request body: (*는 필수)

  • deviceToken*
  • providerId*
  • nickname*
  • imageUrl
  • authorizationCode*

response code: 200


🏞️ 스크린샷 (선택)


🗣️ 리뷰 요구사항 (선택)

노션에는 따로 업데이트 안 했습니다. 해놓을까요?

@mzeong mzeong self-assigned this Jan 14, 2025
Copy link

github-actions bot commented Jan 14, 2025

Test Results

 64 files  ±0   64 suites  ±0   13s ⏱️ ±0s
210 tests ±0  210 ✅ ±0  0 💤 ±0  0 ❌ ±0 
211 runs  ±0  211 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 25b375d. ± Comparison against base commit 848b444.

This pull request removes 6 and adds 6 tests. Note that renamed tests count towards both.
com.ody.auth.JwtTokenProviderTest$validateAccessToken ‑ [1] accessToken=com.ody.auth.token.AccessToken@1f1d3ddf
com.ody.auth.JwtTokenProviderTest$validateAccessToken ‑ [2] accessToken=com.ody.auth.token.AccessToken@4d6adc5a
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [1] date=2025-01-08, time=15:21:14.590490760, expected=false
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [2] date=2025-01-08, time=16:21:14.590512531, expected=true
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [3] date=2025-01-08, time=14:21:14.590501150, expected=false
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [4] date=2025-01-09, time=15:21:14.590490760, expected=true
com.ody.auth.JwtTokenProviderTest$validateAccessToken ‑ [1] accessToken=com.ody.auth.token.AccessToken@677b4d75
com.ody.auth.JwtTokenProviderTest$validateAccessToken ‑ [2] accessToken=com.ody.auth.token.AccessToken@6d0c10bc
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [1] date=2025-01-15, time=19:45:42.321891560, expected=false
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [2] date=2025-01-15, time=20:45:42.321910897, expected=true
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [3] date=2025-01-15, time=18:45:42.321900667, expected=false
com.ody.common.validator.FutureOrPresentDateTimeValidatorTest ‑ [4] date=2025-01-16, time=19:45:42.321891560, expected=true

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jan 14, 2025

📝 Test Coverage Report

Overall Project 82.25% -0.87% 🍏
Files changed 0%

File Coverage
AuthController.java 54.17% -31.25%
AppleAuthRequest.java 0%

@mzeong mzeong marked this pull request as ready for review January 14, 2025 13:25
Copy link
Contributor

@eun-byeol eun-byeol left a comment

Choose a reason for hiding this comment

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

🐹 간단한 코멘트 남겼습니다~ 꼭 확인해주세요!

String nickname,

@Schema(description = "프로필 사진 url", example = "imageurl")
String imageUrl,
Copy link
Contributor

Choose a reason for hiding this comment

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

[제안]
member의 imageUrl이 not null이라 칼럼을 nullable하게 바꾸거나
요청을 not null하게 강제해야 할 것 같아요!

Copy link
Member Author

@mzeong mzeong Jan 14, 2025

Choose a reason for hiding this comment

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

애플 로그인은 카카오와 다르게 프로필 사진을 제공해주지 않아 내부 로직이 개발되면 imageUrl은 nullable로 변경될 예정입니다!

꼼꼼하게 리뷰해주는 조조 고마워요 🐥

Copy link
Contributor

@coli-geonwoo coli-geonwoo left a comment

Choose a reason for hiding this comment

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

별다른 리뷰 사안이 없어 바로 approve 하겠습니다! 간단한 코멘트에 대해선 확인해보시고 반영은 제리에 의사에 맡기겠습니다~

@NotNull
String nickname,

@Schema(description = "프로필 사진 url", example = "imageurl")
Copy link
Contributor

Choose a reason for hiding this comment

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

그럼 스키마 상에서 표기해주는 건 어떨까요?

Suggested change
@Schema(description = "프로필 사진 url", example = "imageurl")
@Schema(description = "프로필 사진 url", example = "imageurl", nullable =true)

Copy link
Member Author

Choose a reason for hiding this comment

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

기존 문서에서도 imageUrl이 필수 정보가 아니라는 점이 나타나서 별도로 표기를 추가하지는 않았습니다!

image

public record AppleAuthRequest(

@Schema(description = "디바이스 토큰", example = "devicetokendevicetoken")
@NotNull
Copy link
Contributor

Choose a reason for hiding this comment

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

Blank 관련 체크도 광범위하게 잡아주어도 좋을 것 같아요. null 뿐만 아니라 "", " "에도 오류가 발생합니다.

Suggested change
@NotNull
@NotBlank

Copy link
Member Author

Choose a reason for hiding this comment

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

[반영] 25b375d (닉네임을 제외한 필드에 NotBlank를 적용했습니다)

@mzeong mzeong merged commit 6765f13 into develop Jan 15, 2025
3 checks passed
@mzeong mzeong deleted the feature/950 branch January 15, 2025 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

docs: 애플 로그인 API 문서화
3 participants