-
Notifications
You must be signed in to change notification settings - Fork 0
[Feat/#7] 공통 API 응답 포맷 추가 #8
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
Open
xeoxxn
wants to merge
2
commits into
feat/#5-jwt-auth-filter
Choose a base branch
from
feat/#7-api-response-format
base: feat/#5-jwt-auth-filter
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+61
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
api/common-api/src/main/java/kr/ac/kookmin/stream/ApiResponse.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package kr.ac.kookmin.stream; | ||
|
|
||
| import kr.ac.kookmin.stream.common.BusinessException; | ||
| import kr.ac.kookmin.stream.common.ErrorCode; | ||
| import lombok.AccessLevel; | ||
| import lombok.Getter; | ||
| import lombok.RequiredArgsConstructor; | ||
|
|
||
| @Getter | ||
| @RequiredArgsConstructor(access = AccessLevel.PRIVATE) | ||
| public final class ApiResponse<T> { | ||
|
|
||
| private static final String SUCCESS_CODE = "SUCCESS"; | ||
| private static final String SUCCESS_MESSAGE = "요청에 성공했습니다."; | ||
|
|
||
| private final boolean success; | ||
| private final String code; | ||
| private final String message; | ||
| private final T data; | ||
|
|
||
| public static <T> ApiResponse<T> success(T data) { | ||
| return new ApiResponse<>(true, SUCCESS_CODE, SUCCESS_MESSAGE, data); | ||
| } | ||
|
|
||
| public static <T> ApiResponse<T> success() { | ||
| return success(null); | ||
| } | ||
|
|
||
| public static <T> ApiResponse<T> error(BusinessException exception) { | ||
| ErrorCode errorCode = exception.getErrorCode(); | ||
| return new ApiResponse<>(false, errorCode.name(), exception.getMessage(), null); | ||
| } | ||
|
|
||
| public static <T> ApiResponse<T> error(ErrorCode errorCode) { | ||
| return new ApiResponse<>(false, errorCode.name(), errorCode.message(), null); | ||
| } | ||
|
|
||
| public static <T> ApiResponse<T> error(String code, String message) { | ||
| return new ApiResponse<>(false, code, message, null); | ||
| } | ||
| } | ||
15 changes: 15 additions & 0 deletions
15
api/common-api/src/main/java/kr/ac/kookmin/stream/CursorSliceResponse.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package kr.ac.kookmin.stream; | ||
|
|
||
| import java.util.List; | ||
| import kr.ac.kookmin.stream.common.CursorSliceResult; | ||
|
|
||
| public record CursorSliceResponse<T>(List<T> content, boolean hasNext, Long nextCursor) { | ||
|
|
||
| public static <T> CursorSliceResponse<T> from(CursorSliceResult<T> result) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 정적 팩토리 메서드로 객체 생성하는 거 좋습니다👍 |
||
| return new CursorSliceResponse<>( | ||
| result.content(), | ||
| result.hasNext(), | ||
| result.nextCursor() | ||
| ); | ||
| } | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
core/common/src/main/java/kr/ac/kookmin/stream/common/CursorSliceResult.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package kr.ac.kookmin.stream.common; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| public record CursorSliceResult<T>(List<T> content, boolean hasNext, Long nextCursor) {} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CursorSliceResponse는 record로 정의하셨는데,ApiResponse는 final class로 정의하신 이유가 따로 있을까요?!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR 본문에서 확인했습니다!
일단 인증 PR 머지 전까지 대기해 주세요~