REST API

📙REST

💡Open API (Application Programming Interface)

• 포털 서비스 사이트나 관공서, 공공 데이터 포털이 가지고 있는 데이터를 외부 응용 프로그램(Java, Python 등)에서 사용할 수 있도록 Open API를 제공
• 대부분의 Open API는 REST 방식으로 지원

💡REST(Representational State Transfer)

• URI(리소스, 데이터) + 전송방식(GET/POST/PUT/DELETE) → 원하는 작업(command)을 지정
• HTTP URI를 통해 제어할 자원을 명시하고, HTTP Method(GET, POST, PUT(UPDATE), DELETE)을 통해 해당 자원을 제어하는 명령을 내리는 방식의 아키텍처

💡REST 구성

• 자원(Resource) - URI로 식별
• 행위(Verb) - HTTP Method로 정의
• 표현(Representations) : JSON, XML 등의 형식

잘 표현된 HTTP URI로 리소스를 정의하고 HTTP method로 리소스에 대한 행위를 정의

💡기존 Service와 REST Service

• 기존 Service
  • 요청에 대한 처리를 한 후 가공된 data를 이용하여 특정 플랫폼에 적합한 형태의 View로 만들어서 반환
  • form or link를 통해 parameter로 요청
    ✔️즉, 화면을 만드는 곳은 Server.
• REST Service
  • data 처리만 한다거나, 처리 후 반환될 data가 있다면 JSON이나 XML 형식으로 전달
  • AJAX로 요청 (fetch)
    ✔️즉, 화면을 만드는 곳은 Client.

📙REST API

서버는 요청으로 받은 리소스에 대해 순수한 데이터를 전송한다.

• GET/POST/PUT/ DELETE 방식을 사용하여 리소스에 대한 CRUD 처리를 할 수 있다.
• HTTP URI을 통해 제어할 자원을 명시하고, HTTP Method를 통해 해당 자원을 제어하는 명령을 내리는 방식의 Architecture
• 자원을 표현할 때 Collection(문서, 객체의 집합)과 Document(하나의 문서, 객체) 사용

💡관련 Annotation

• @RestController : Controller가 REST 방식을 처리하기 위한 것임을 명시
• @ResponseBody : JSP 같은 뷰로 전달되는 것이 아니라 데이터 자체를 전달
• @PathVariable : URL 경로에 있는 값을 파라미터로 추출
• @CrossOrigin : AJAX의 크로스 도메인 문제를 해결
• @RequestBody : JSON 데이터를 원하는 타입으로 바인딩

💡 Jackson library

1. jackson-databind 라이브러리
   • 객체를 JSON 포맷의 문자열로 변환시켜서 브라우저로 전송
   • RESTful API에서 데이터를 JSON 형식으로 클라이언트에 전송할 때 주로 사용
2. jackson-dataformat-xml 라이브러리
   • 객체를 xml로 브라우저로 전송
   • XML 형식의 데이터를 클라이언트에 전송해야 할 때 사용

📙ResponseEntity< T >

💡ResponseEntity< T >의 기본 구조

• HTTP 응답을 세부적으로 구성하고 반환할 수 있게 하는 클래스
• 주로 REST API에서 client에게 상태 코드, 응답 헤더, 본문 데이터를 포함한 응답을 보낼 때 사용
  • 응답 본문(response body)에 포함될 데이터 타입을 지정
  • T의 타입으로는 String, Object, Dto 등이 일반적, 필요에 따라 Void도 가능

public class ResponseEntity<T> extends HttpEntity<T> {}

💡 ResponseEntity 주요 기능과 설정 요소

1. 상태 코드 설정
   • HTTP 응답에 포함될 코드를 설정

   ResponseEntity<String> response = new ResopnseEntity<>(HttpStatus.OK);

2. 본문 설정
   • 응답의 본문으로 전달할 데이터를 지정
   • JSON, XML 등으로 직렬화되어 클라이언트에 전달

   ResponseEntity<List<MemberDto>> response = new ResponseEntity<List<MemberDto>>(list, HttpStatus.OK);

3. 헤더 설정
   • Content-Type, Location 등의 헤더 값 설정 가능
   • HTTP 응답 헤더를 커스터마이즈할 수 있다.

   HttpHeaders headers = new HttpHeaders();
   headers.add("Custom-Header", "HeaderValue");
   ResponseEntity<String> response = new ResponseEntity<>("Body Content", headers, HttpStatus.OK);

💡ResponseEntity< T >의 생성 방식

1. 생성자를 사용한 방식

   • body, headers, status를 직접 지정하여 ResponseEntity를 생성한다.

   return new ResponseEntity<T>(body, headers, HttpStatus.Ok);

2. 빌더 패턴을 사용한 방식

   • 높은 가독성, 유지보수 용이
   • 주요 메서드
     • ok() : HTTP 200 Status Code와 함께 Response를 생성
     • status() : 특정 HTTP Status Code를 직접 설정
     • created(URI) : 201 Created 상태 코드와 함께 Location 헤더에 URI를 포함한 응답을 생성
     • body() : 응답 본문을 설정
     • headers() : 응답 헤더를 설정
     • build() : 응답의 body가 없을때 ResponseEntity를 생성해 반환
   • 체이닝 방식으로 본문이나 헤더를 추가

     return ResponseEntity.ok().headers(headers).body(body);