[ShareMore] 3. API Response 통일

🎈 API 응답을 통일해봅시다!

먼저 response에 들어갈 값들을 설정해볼게요!

1.기본적인 httpStatus
2.성공인지 실패인지 명확히 표기
3.사용자 설정 code (ex. "MEM001")
4.세부 내용

@Getter
@Builder
public class ErrorReasonDTO {

    private HttpStatus httpStatus;

    private final boolean isSuccess;
    private final String code;
    private final String message;

    public boolean getIsSuccess(){return isSuccess;}
}

@Getter
@Builder
public class ReasonDTO {

    private HttpStatus httpStatus;

    private final boolean isSuccess;

    private final String code;

    private final String message;

    public boolean getIsSuccess(){return isSuccess;}

}

---

그다음 응답코드의 ENUM에서 상속할 BaseCode 인터페이스 선언해 줄게요!

public interface BaseCode {

    public ReasonDTO getReason();

    public ReasonDTO getReasonHttpStatus();
}

public interface BaseErrorCode {

    public ErrorReasonDTO getReason();

    public ErrorReasonDTO getReasonHttpStatus();
}

---

이제 각 응값값에서 사용할 code ENUM값 설정해 주겠습니다!

@Getter
@AllArgsConstructor
public enum ErrorStatus implements BaseErrorCode {

    _INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON500", "서버 내부 에러"),
    _Bad_Request(HttpStatus.BAD_REQUEST, "COMMON400", "잘못된 요청입니다"),
    _UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "COMMON401", "인증이 필요합니다"),
    _FORBIDDEN(HttpStatus.FORBIDDEN, "COMMON403", "금지된 요청입니다"),
    //가장 일반저긴 응답

    TEMP_EXCEPTION(HttpStatus.BAD_REQUEST, "TEMP40001", "이거는 테스트");

    private final HttpStatus httpStatus;
    private final String code;
    private final String message;


    @Override
    public ErrorReasonDTO getReason() {
        return ErrorReasonDTO.builder()
                .message(message)
                .code(code)
                .isSuccess(false)
                .build();
    }

    @Override
    public ErrorReasonDTO getReasonHttpStatus() {
        return ErrorReasonDTO.builder()
                .message(message)
                .code(code)
                .httpStatus(httpStatus)
                .isSuccess(false)
                .build();
    }
}

@Getter
@AllArgsConstructor
public enum SuccessStatus implements BaseCode{

    _OK(HttpStatus.OK, "COMMON200", "성공입니다");

    private final HttpStatus httpStatus;
    private final String code;
    private final String message;


    @Override
    public ReasonDTO getReason() {
        return ReasonDTO.builder()
                .message(message)
                .code(code)
                .isSuccess(true)
                .build();
    }

    @Override
    public ReasonDTO getReasonHttpStatus() {
        return ReasonDTO.builder()
                .message(message)
                .code(code)
                .httpStatus(httpStatus)
                .isSuccess(true)
                .build();
    }
}

---

마지막으로 응답으로 보낼 json의 뼈대를 만들어 주겠습니다!

@Getter
@AllArgsConstructor
@JsonPropertyOrder({"isSuccess", "code", "message", "result"})
public class ApiResponse<T> {

    @JsonProperty("isSuccess")
    private final Boolean isSuccess;
    private final String code;
    private final String message;
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private T result;

    public static <T> ApiResponse<T> onSuccess(T result) {
        return new ApiResponse<>(true, SuccessStatus._OK.getCode(), SuccessStatus._OK.getMessage(), result);
    }

    public static <T> ApiResponse<T> onFailure(String code, String message, T data) {
        return new ApiResponse<>(false, code, message, data);
    }

}

@JsonProperty

어노테이션은 객체를 JSON 형식으로 변환할 때 Key의 이름을 설정할 수 있습니다.
클라이언트는 스네이크케이스, 서버는 카멜케이스로 소통하는 경우가 많기 때문에 맞춰주기 위해 사용합니다!

@JsonInclude(JsonInclude.Include.NON_NULL)

널 값이 아닌 경우에만 반환

---

Test

test에서 반환될 객체를 선언해줄게요!

public class TempResponse {

    @Builder
    @Getter
    @NoArgsConstructor
    @AllArgsConstructor
    public static class TempResponseDTO {
        String testString;
    }

}

converter에서는 dto를 생성해줄게요!

public class TempConverter {

    public static TempResponse.TempResponseDTO toTempTestDTO() {
        return TempResponse.TempResponseDTO.builder()
                .testString("This is Test!")
                .build();
    }
}

controller 생성해 줄게요!

@RestController
@RequestMapping("/api/temp")
@RequiredArgsConstructor
public class TempController {

    private final TempQueryService tempQueryService;

    @GetMapping("/test")
    public ApiResponse<TempResponse.TempResponseDTO> getTest() {
        return ApiResponse.onSuccess(TempConverter.toTempTestDTO());
    }
}

성공!