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

@LoginMember가 스웨거 파라미터에 포함되지 않도록 수정. 인증 정보 입력할 수 있도록 수정 #204

Merged
merged 3 commits into from
Aug 4, 2024

Conversation

Mingyum-Kim
Copy link
Contributor

@Mingyum-Kim Mingyum-Kim commented Aug 3, 2024

PR의 목적이 무엇인가요?

  1. 컨트롤러 파라미터에 @LoginMember 어노테이션을 붙여서 Header 로 토큰을 가져오도록 하고 있습니다. 스웨거에서 이 파라미터를 필수로 넣어야 하는 불편함이 있기 때문에 스웨거 설정 파일을 생성해서 해당 어노테이션이 추가된 파라미터는 제외하도록 설정하였습니다.

  2. 스웨거에서 로그인 후 헤더에 토큰을 추가하기 위한 간편한 설정을 추가하였습니다.

이슈 ID는 무엇인가요?

설명

로그인 후 생성된 토큰을 아래 Authorize 버튼을 누르고 입력하면 로그인된 상태로 API 요청이 가능합니다.

image

image

질문 혹은 공유 사항 (Optional)

LoginMember 어노테이션에 대한 파라미터 제외,, Authorization 토큰 주입을 위한 설정 파일 생성
@Mingyum-Kim Mingyum-Kim added BE 백엔드 관련 이슈입니다. 🚑 버그 fix (develop에서 파생된 문제) labels Aug 3, 2024
@Mingyum-Kim Mingyum-Kim self-assigned this Aug 3, 2024
@Mingyum-Kim Mingyum-Kim linked an issue Aug 3, 2024 that may be closed by this pull request
2 tasks
Copy link
Contributor

@ay-eonii ay-eonii left a comment

Choose a reason for hiding this comment

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

인증 추가해주다니 !! 고맙습니다 안나 👍

));
}

private SecurityScheme createAPIKeyScheme() {
Copy link
Contributor

Choose a reason for hiding this comment

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

의견 ) createBearerTokenScheme 메서드명이 더 어울릴 것 같은데 어떠세용?

Copy link
Contributor

Choose a reason for hiding this comment

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

저도 키 보다는 토큰으로 메서드명을 표기하는 것에 동의 합니다 😁

Copy link
Contributor Author

Choose a reason for hiding this comment

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

네넵 반영하였습니다 !

Copy link
Contributor

@ksk0605 ksk0605 left a comment

Choose a reason for hiding this comment

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

고마워요 안나
덕분에 팀원들이 테스트 할 때 편해지겠네요
👍👍

));
}

private SecurityScheme createAPIKeyScheme() {
Copy link
Contributor

Choose a reason for hiding this comment

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

저도 키 보다는 토큰으로 메서드명을 표기하는 것에 동의 합니다 😁

@Mingyum-Kim Mingyum-Kim merged commit 5cc6520 into develop-backend Aug 4, 2024
1 check passed
@Mingyum-Kim Mingyum-Kim deleted the fix/#176 branch August 4, 2024 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BE 백엔드 관련 이슈입니다. 🚑 버그 fix (develop에서 파생된 문제)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

스웨거에 Member 파라미터가 포함되는 문제 해결
3 participants