[BE] docs: GitHub 연동, 자신이 만든 리뷰 그룹 목록 조회 API 문서 작성 #1014
Conversation
backend/src/main/java/reviewme/auth/controller/AuthController.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/member/controller/MemberController.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/reviewgroup/controller/ReviewGroupController.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupDetailResponse.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/auth/controller/AuthController.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupListResponse.java
Outdated
Show resolved
Hide resolved
| @PostMapping("/v2/auth/github") | ||
| public ResponseEntity<Void> authWithGithub( | ||
| @Valid @RequestBody GithubCodeRequest request, | ||
| HttpServletRequest httpRequest | ||
| ) { | ||
| return ResponseEntity.ok().build(); | ||
| } |
There was a problem hiding this comment.
산초가 올려준 디스커션의 인증 과정중 아래의 1~3번을 이 메서드에서 모두 하는것인지 궁금해요!(아직 구현이 안해서 헷갈려서 물어봅니당)
- auth code를 받음
- 그걸로 깃헙에 accessToken을 요청함
- 받은 accessToken으로 깃헙에 사용자의 정보를 요청해서 세션을 설정해 응답함
There was a problem hiding this comment.
혹시 이때 사용자 정보나 로그인 정보같은 것은 안내려줘도 괜찮나요?
There was a problem hiding this comment.
@Kimprodp
사용자 정보를 따로 넘겨주기보다, 클라이언트와는 JSESSION_ID로만 로그인한 사용자에 대한 통신을 하면 된다 생각해요!
There was a problem hiding this comment.
정보를 1회성으로 내려주는 게 좋을까요, 프론트에서 정보를 확인할 수 있는 API를 뚫어두는 게 좋을까요?
There was a problem hiding this comment.
- 1회성이라는 건: 어떤 뜻인지 잘 모르겠어요
- 프론트에서 정보를 확인할 수 있는 API: 사용자 세션을 갖고 프로필 api를 찌르게 하는 것
을 말하는 게 맞을까요? 그렇다면 저는 2번을 생각했었어요~
backend/src/main/java/reviewme/member/controller/MemberController.java
Outdated
Show resolved
Hide resolved
backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupListResponse.java
Outdated
Show resolved
Hide resolved
| String projectName, | ||
| LocalDate createdAt, | ||
| String reviewRequestCode | ||
| ) { |
There was a problem hiding this comment.
프로젝트 목록에서 해당 프로젝트에 리뷰가 몇 개 작성되어있는지도 같이 제공하면 어떨까요?
There was a problem hiding this comment.
오~ 괜찮은데요? 이건 프론트 분들이랑 이야기를 해봐야 할 것 같아요!
backend/src/main/java/reviewme/reviewgroup/service/dto/ReviewGroupListResponse.java
Outdated
Show resolved
Hide resolved
|
|
||
| import java.util.List; | ||
|
|
||
| public record ReviewGroupListResponse( |
There was a problem hiding this comment.
어떤 회원의 그룹 목록인지 확인할 수 있도록 memberId 필드에 추가하는 건 어떻게 생각하시나요?
#1017 (comment)
저희가 작업한 dto와 같은 이유입니다~
There was a problem hiding this comment.
음 이거에 대해서 다시 생각해봤는데, 불필요한 응답 같다고 다시 생각을 바꾸게 되었어요///😔
#1017 (comment)
여기에 코멘트 달아놨습니다!
| @PostMapping("/v2/auth/github") | ||
| public ResponseEntity<Void> authWithGithub( | ||
| @Valid @RequestBody GithubCodeRequest request, | ||
| HttpServletRequest httpRequest | ||
| ) { | ||
| return ResponseEntity.ok().build(); | ||
| } |
There was a problem hiding this comment.
혹시 이때 사용자 정보나 로그인 정보같은 것은 안내려줘도 괜찮나요?
| @@ -48,4 +49,11 @@ public ResponseEntity<Void> checkGroupAccessCode( | |||
| session.setAttribute("reviewRequestCode", request.reviewRequestCode()); | |||
| return ResponseEntity.noContent().build(); | |||
| } | |||
|
|
|||
| @GetMapping("/v2/groups/mine") | |||
| public ResponseEntity<ReviewGroupPageResponse> getMyReviewGroups() { | |||
There was a problem hiding this comment.
#1014 (comment)
같은 이유입니다~
getReviewGroupSummary의 api를 /groups/summary로 하고,
여기에는 mine을 빼고 /groups 까지만 하는 것이 괜찮아 보입니다.
There was a problem hiding this comment.
GET /groups 는 그룹 자체에 대한 정보에 더 가깝다고 생각합니다.
'내가 만든 리뷰 그룹'을 나타내기에는 조금 부족하다는 생각이 드는데,
/v2/groups/authored 는 어떤가요?
아직 안 됐습니다~
우선 나의 리뷰 그룹 목록 보기만 만들어두었어요
🚀 어떤 기능을 구현했나요 ?
📝 어떤 부분에 집중해서 리뷰해야 할까요?