[Spring] REST API - ResponseEntity 오브젝트

REST API - ResponseEntity 오브젝트

- ResponseEntity 오브젝트는 HTTP 응답의 바디에 삽입할 오브젝트를 소유한다 (예제에서 Customer해당)

- ResponseEntity 오브젝트는 바디 오브젝트에 추가해 스테이터스 코드와 HTTP 응답 헤더를 설정할 수 있다

1. ResponseEntity의 프로퍼티

프로퍼티 이름	타입	설명
statusCode	org.springframework.http.HttpStatus	스테이터스 코드
headers	org.springframework.http.HttpHeaders	HTTP 응답
body	T(ResponseEntity 오브젝트 생성 시에 형 변수지정)	바디에 삽입할 정보를 유지하는 오브젝트

2. ResponseEntity

@RequestMapping(value = "/{customerId}", method=GET) public ResponseEntity<Customer> findById(@PathVariable int customId) throws DataNotFoundException{ //1 Customer customer = customerService.findById(customerId); //2 HttpHeaders headers = new HttpHeaders(); headers.setContentType(new MediaType("text","xml", Charset.forName("UTF-8")); headers.set("My-Header","MyHeaderValue"); return new ResponseEntity<Customer>(customer, headers, HttpStatus.OK); //3 }

1) 반환 값이 ResponseEntity 클래스가 된 것을 확인

- ResponseEntity 반환이면 그 내용을 HTTP 응답에 삽입하는 것은 명확하므로 @ResponseBody 설정 필요없다

- 스테이터스 코드도 오브젝트에 설정하므로 @ResponseCode 설정할 필요없다

2) HTTP 응답 헤더 정보를 유지하는 HttpHeaders 오브젝트

-  여기에 콘텐츠 타입이나 My-Header라는 이름의 헤더설정

- ResponseEntity 오브젝트를 사용함으로 개별적 헤더를 설정 할 수 있다

3) 바디오브젝트, 헤더오브젝트, 스테이터스 코드 반환