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

[제안] Response format #2

Open
kamothi opened this issue Mar 5, 2024 · 3 comments
Open

[제안] Response format #2

kamothi opened this issue Mar 5, 2024 · 3 comments

Comments

@kamothi
Copy link
Member

kamothi commented Mar 5, 2024

  • 현재 각각의 api 마다 Response 형식이 통일되지 않고 있음.
  • msa에서 각각의 서비스가 다르더라도 포맷을 통일화 하는게 좋아보임
  • Response class를 하나 따로 세팅하고 이 포맷을 서비스마다 통일화
    ex)
    { "success": true, "code": 0, "message": "Ok", "data": [ 1, 2, 3 ] }
@david-parkk
Copy link

david-parkk commented Mar 6, 2024

public record ApiResponse<T>(Boolean isSuccess, int code, String message,
                             @JsonProperty(value = "response") T response,
                             @JsonProperty(value = "errorResponse") ErrorResponse errorResponse) {
}

호출 예시

return new ApiResponse(true,200,"success", posting, null);

@kamothi
Copy link
Member Author

kamothi commented Mar 6, 2024

message에는 구체적으로 어떤 정보가 들어가나요?
단순 성공, 실패 여부면 message와 isSuccess를 나눈 이유가 있을까요?

@david-parkk
Copy link

message에는 해당 API 통신 결과를 대표할 수 있는 의도로 만들었습니다. 예를들어 error일 경우 message에서 해당 error type를 넣고 구체적인 내용은 errorReponse에 넣게 됩니다.
isSuccess와 의미가 중복되는 것 같긴 하네요

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants