Repository navigation
[스웨거] 일부 API 문서화 및 설정 변경 - #21
Conversation
| ModelAndViewContainer mavContainer, | ||
| NativeWebRequest webRequest, | ||
| WebDataBinderFactory binderFactory) throws Exception { | ||
| public UUID resolveArgument(MethodParameter parameter, |
There was a problem hiding this comment.
AuthTokenArgumentResolver 쪽도 수정해도 될 것 같네요
감사합니다
| public record IdRs( | ||
| String id | ||
| ) { | ||
| } |
There was a problem hiding this comment.
여긴 모든 도메인조회시 Id를 리턴하기 위함인가요..?
- 여기에는 어노테이션으로 스웨거 설정이 안되어 있는거 같아요
There was a problem hiding this comment.
맞습니당 Id만 리턴하는 경우가 많아서 그경우 공통으로 쓰기 위해... 추가해뒀습니다
There was a problem hiding this comment.
- 생성 시 사용하는 Rs로 명칭 변경했습니다
IdRs->CreateIdRs
There was a problem hiding this comment.
Id만을 담는 공통 응답 객체를 만드는 부분에 대해 좀 고민이 되네요,, 🤔
- 우선
어떤 도메인에서 온 ID인지가 명확하지 않으면 응답 자체의 의미가 애매해질 것 같아요. - ex) 예를 들어 UserIdRs처럼 사용하는게 더 명확할 수도 있지 않을까 싶어요.
➕ CreateIdRs라는 네이밍은 "생성 시 반환하는 ID"를 의미하는 것 같은데 update나 delete 요청에서도 ID를 반환한다면 그때도 각각 UpdateIdRs, DeleteIdRs를 만들어야 하는지 의문이 들어요.
- 응답 객체에는 어떤 값을 반환하는지에 대해 표현하는게 좀 더 중요한 것 같아요.(제 생각)
- 위에 코멘트 남긴 것과 마찬가지로 HTTP Method로도 어떤 행동을 하는 것인지 전달될 수도 있다고 생각해요.
There was a problem hiding this comment.
완전 이해했습니다!.!
IdRs 자체가 편의를 위해 만든 거라 코드 품질 측면에서 봤을 땐 좋지 않게 느껴질 것 같아요
Rs모델 같은 경우 공통화 하지 않고 각 도메인에 적합한 네이밍으로 사용하는 쪽으로 변경하겠습니다 의견 감사합니다 :-)
|
|
||
| @NotNull | ||
| @Schema(description = "목표 완료 날짜", format = "date") | ||
| LocalDate date, |
There was a problem hiding this comment.
| LocalDate date, | |
| LocalDate dueDate, |
여기 변수명이
- GoalCreateRq에서는 dueDate라 통일하면 좋을거 같아요.
| @Target({ElementType.METHOD, ElementType.PARAMETER}) | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Documented | ||
| @Parameter(hidden = true) |
|
|
||
| @Size(min = 1, max = 12) | ||
| @Schema(description = "목표 개월 수") | ||
| Integer month, |
There was a problem hiding this comment.
여기서 Integer 사용한 이유는 목표 개월수가 없을수도 있어서 일까요?
|
|
||
| @NotNull | ||
| @Schema(description = "개월 수로 기간 설정 여부") | ||
| boolean isMonthSetting, |
There was a problem hiding this comment.
이거 있어야 할까요?
저는 개월 수로 목표 설정하더라도 목표 설정 날짜 기준으로 + 개월 수 해서 완료 날짜를 설정하는거 생각했었습니다.
There was a problem hiding this comment.
date만 사용할 경우 클라이언트측에서 오늘 날짜 + 3개월 해서 날짜를 넘겨주게 되는데 그것보다 서버에서 계산하는 게 정확하다고 생각해서 우선 이런식으로 해뒀습니다
생각했던 변수: 클라이언트에서 정확한 오늘날짜를 가지고 있지 않을 가능성이 있다고 생각 (기기 설정/캐시 문제 등)
저도 고민했던 부분이라 추가 의견 주시면 반영하겠습니다!.!
There was a problem hiding this comment.
그렇다면!
서버가 오늘 날짜 기준으로 개월 수(month)만 받아서 완료일을 계산한다면
→ isMonthSetting 없이 month가 존재하면 plus 해주기..? 이런 식으로 사용할 수도 있지 않을까요??
There was a problem hiding this comment.
으음... 값 null check 후 다른 동작 <- 해당 플로우가 그렇게 안정적이진 않다고 생각했습니다
month가 null일 경우 dueDate를 사용한다고 확신할 수 있는가?
-> 둘은 사실 별개의 값으로 B라는 값의 사용 여부를 A의 없음 여부로 판단할 수 없다고 생각했고, 그래서 플래그를 두는 게 맞다고 판단했어요
isMonthSetting 플래그를 사용한다면 클라이언트가 하나의 값을 정확히 의도하고 보낸 것을 신뢰할 수 있게되고, 더 명확하다고 생각했어요 (@NotNull도 사용 가능)
이런 이유로 요청 값에 대해서는 플래그를 뒀을 때 장점이 더 크다고 생각한 것 같아요 :-)...
There was a problem hiding this comment.
좋은거 같아요!@! 🙌🏻 isMonthSetting 네이밍을 조금만 더 명확히 했으면 좋겠다는 생각은 있습니다 ..
근데 뭐가 좋으려나요..ㅎ;ㅎ;ㅎ;ㅎ;
There was a problem hiding this comment.
뭔가 딱 마음에 드는 건... 없네요
- isMonthBased
- isMonthMode
- isPeriodByMonths
isMonthBased는 어떨까요? 아니면 isPeriodByMonths?
| @PutMapping("/{id}") | ||
| public IdRs update(@PathVariable String id, GoalUpdateRq rq) { | ||
| return null; | ||
| } |
There was a problem hiding this comment.
| @PutMapping("/{id}") | |
| public IdRs update(@PathVariable String id, GoalUpdateRq rq) { | |
| return null; | |
| } | |
| @PutMapping("/{id}") | |
| @ResponseStatus(HttpStatus.NO_CONTENT) | |
| public void update(@PathVariable String id, GoalUpdateRq rq) { | |
| } |
요거 IdRs 반환하는 이유 궁금해요~!
|
가입일, 닉네임 등 자주 쓰고 보안상 위험하지 않은 정보는 로그인 / 토큰 갱신시 응답에서 함께 내려주고 클라이언트가 일정 세션동안 유지하도록 하면 어떤가요..? |
|
|
|
||
| @NotNull | ||
| @Schema(description = "개월 수로 기간 설정 여부") | ||
| boolean isMonthSetting, |
There was a problem hiding this comment.
그렇다면!
서버가 오늘 날짜 기준으로 개월 수(month)만 받아서 완료일을 계산한다면
→ isMonthSetting 없이 month가 존재하면 plus 해주기..? 이런 식으로 사용할 수도 있지 않을까요??
| @Schema(description = "세부 목표 목록") | ||
| List<SubGoalCreateRq> subGoals | ||
| ) { | ||
| public GoalCreateRq { | ||
| if (Objects.isNull(subGoals)) { | ||
| subGoals = new ArrayList<>(); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
| @Schema(description = "세부 목표 목록") | |
| List<SubGoalCreateRq> subGoals | |
| ) { | |
| public GoalCreateRq { | |
| if (Objects.isNull(subGoals)) { | |
| subGoals = new ArrayList<>(); | |
| } | |
| } | |
| } | |
| @Schema(description = "세부 목표 목록") | |
| @JsonSetter(nulls = Nulls.AS_EMPTY) | |
| List<SubGoalCreateRq> subGoals | |
| ) { | |
| } |
요거 subGoals가 null로 들어올 경우를 방지하기 위해 생성자에서 null 체크 후 빈 리스트로 초기화하신 부분인 것 같아요!@!
이런 경우에는 @JsonSetter(nulls = Nulls.AS_EMPTY) 어노테이션 사용할 수도 있을 거 같아요@!
좋은 것 같습니다 @qjatjr29 |
| } | ||
|
|
||
| @GetMapping | ||
| public GoalListRs readList(@AuthUser UUID userId) { |
There was a problem hiding this comment.
| public GoalListRs readList(@AuthUser UUID userId) { | |
| public GoalListRs getGoals(@AuthUser UUID userId) { | |
| 또는 | |
| public GoalListRs getGoalList(@AuthUser UUID userId) { |
요거 readList는 어떤 것을 가져오는지 명확하지 않을 수 있을거 같아요~
➕ read는 파일이나 스트림 같은 것들을 읽을 때 사용하는 표현인거 같아서 get 을 사용하도록 하는건 어떨까요?
There was a problem hiding this comment.
오호 확인했습니다~
Rs같은 경우도 GoalGetRs처럼 바꾸는 게 좋을까요?
There was a problem hiding this comment.
Response 같은 경우는 Get 같은건 굳이 안 넣어도 될거 같아요!
- 어떤 값을 반환하는지만?!
여기서 GoalRs << 이라는 Rs가 있다면
public List<GoalRs> getGoalList(@AuthUser UUID userId)
public Page<GoalRs> getGoalList(@AuthUser UUID userId)
이렇게도 할 수 있을거 같긴합니다
- 투두 리스트를 반환할 때는 Slice 사용 하는거 생각하고 있긴합니다.. (스크롤 방식이길래) - 좀 더 고민해볼예정!
There was a problem hiding this comment.
앗 맞네요잉 헷갈렸습니다 ~! 화긴!.!
@jongeuni @GetMapping("/me/joined-date") // 요거 |
|
@qjatjr29 넵 그렇게 하겠습니다 :-) |
@jongeuni
|
|
@qjatjr29
앱으로 가면 변경이 필요할 수도 있는데 일단은 웹이니까 괜찮을 것 같습니다 +그런데... ...
의견 알려주실 수 있을까요? 😅 너무 깊게 생각한 것 같기도 하고 😅 |
|
로그인 시 메타 정보로 함께 반환하는 방법
메인 화면 진입 시마다 별도의 API를 호출하는 것은 낭비일 수도 있지 않을까..? 별도 API로 분리하게 된다면??
고려해볼 내용 🤔
해당 가입일 정보가 변화 가능성 있는지??? 를 고려해서 다시 생각해 볼 필요가 있을 것 같아요.. 어렵네요 또, (질문) |
|
@qjatjr29
목표 시작일의 경우 어제 나눈 대화랑 헷갈렸던 것 같아요 (...) 어쨌뜬~ 토큰 응답값으로 사용하는걸로 가시죵 good입니다 |
📌 관련 이슈
#18
✨ 작업 개요
AControllerSwagger로 해두었습니다 (docs 패키지 안)✅ 작업 상세 내용
@AuthUser@AuthToken스웨거에서 숨겨지도록 애노테이션 수정💬 기타 참고 사항
@AuthUser@AuthToken에 애노테이션 추가했는데 순서 적절한지 말씀 주세요 👍resolveArgument()리턴 타입을 UUID로 수정했는데 이렇게 해도 괜찮은지 확인 부탁드려요모티모와 1일차에 해당하는 부분을UserController에서 가입 날짜 조회 API로 만들었습니다 의견 주세요 :-)UserInfoController같은걸 하나 만들어도 좋을 것 같습니다