[Spring boot] ResponseEntity

Spring Framework에서 제공하는 클래스 중 HttpEntity라는 클래스가 존재한다. 이것은 HTTP 요청(Request) 또는 응답(Response)에 해당하는 HttpHeader와 HttpBody를 포함하는 클래스이다.

ResponseEntity를 사용해서 클라이언트에게 상태코드, 메시지, 데이터 등을 담은 필드로 응답을 보낼 수 있어서 형식을 정해 놓아 보낼 수 있다는 것이 좋습니다.

API Response 형태

BasicResponse

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class BasicResponse {
    private Integer statuscode;
    private HttpStatus status;
    private String message;
    private List<Object> data;
}

statuscode : 상태코드

status : 요청 상태

message : 상태 설명

data : 게시글 담을 리스트

Service

BasicResponse basicResponse = BasicResponse.builder()
            .statuscode(HttpStatus.OK.value())
            .status(HttpStatus.OK)
            .message("전체 게시글 조회 성공")
            .data(new ArrayList<>(데이터_리스트)).build();

        return new ResponseEntity<>(basicResponse, HttpStatus.OK);

참고 : https://data-make.tistory.com/710