[REFACTOR] swagger 관련 코드 controller에서 분리 #141
Conversation
|
그러네요, 메소드 파라미터 부분에 memberId 값을 바인딩 하도록 해놓은 게 스웨거에서도 그대로 보이는군요... |
| @PostMapping("/login/{oauthServerType}") | ||
| ApiResponse<SuccessBody<TokenResponse>> login( | ||
| public ApiResponse<SuccessBody<TokenResponse>> login( | ||
| @PathVariable String oauthServerType, | ||
| @RequestParam("code") String code, | ||
| @RequestParam("redirect_uri") String uri, |
There was a problem hiding this comment.
이전에 Slack으로 보내주신 사진을 보면, RequestMapping과 PathVariable, RequestParam도 모두 Interface로 빼놓았는데, 지금은 안 빼놓으신 이유가 Controller 메소드 코드를 봤을 때, 어떻게 동작하는지 바로 알 수 있게 하기 위함인가요?!
There was a problem hiding this comment.
넵!! 맞아요!!
RequestMapping과 PathVariable, RequestParam은 web에 의존적인 것이라고 판단했어요!!
swagger가 아닌 다른 문서로 변경되었을 때 web 코드가 변경되어야 하는가?
만약 추후 swagger가 아닌 다른 문서로 변경이 된다고 했을 때 RequestMapping과 PathVariable, RequestParam와 같은 web 계층의 변화는 없어야 한다고 생각했어요.
해당 라이브러리들의 패키지를 기준
- RequestMapping과 PathVariable, RequestParam는
package org.springframework.web.bind.annotation;패키지에 속한다. - 즉 web 계층에 의존적이라고 생각했습니다.
- 반면 swagger 어노테이션은
package io.swagger.v3.oas.annotations;에 속한다. - 즉 swagger 에 의존적이라고 생각했습니다.
이러한 패키지의 위치를 기준으로 interface로 나누었습니다.
There was a problem hiding this comment.
아 그렇네요 Swagger에 Web 어노테이션을 붙이면, Web 어노테이션이 Swagger와 공존해서, 의존성이 생겨버리니까 분리를 한 거군요! 이해됐습니다! 감사합니다!
|
@rlajm1203 주석 처리한 테스트를 통과시켜야지만 Ci가 통과할 것 같아요... ㅠㅠㅠㅠㅠㅠㅠ |
📌 관련 이슈
closed #135
✒️ 작업 내용
swagger 관련 코드를 interface에서 분리했습니다.
swagger에서 memberId 파라미터 노출을 제거
Guest 권한을 나타내는 객체 디렉터리 위치 변경커밋
스크린샷 🏞️ (선택)
memberId를 노출했던 이전 swagger
memberId를 노출하지 않는 swagger
💬 REVIEWER에게 요구사항 💬
전체 테스트가 돌아가지 않아 확인을 보니 실패하는 테스트들이 존재했습니다.
하지만 이는 메서드 시그니처가 변경되어 발생하는 문제였고 추가된 기능에 대한 파악이 우선적으로 되어야 한다고 생각했습니다.
따라서 통과하지 않는 테스트, 테스트 코드 추가는 별도의 이슈를 통해 해결하고자 합니다.