[Spring] REST API란 ?

•  OPEN API (Application Programming Interface)

      - OPEN API는 프로그래밍에서 사용할 수 있는 개방되어 있는 상태의 Interface.

      - 공공 데이터 포털 등이 가지고 있는 데이터를 외부 응용 프로그램에서 사용할 수 있도록 OPEN API를 제공하고 있다.

      - OPEN API와 함께 거론되는 기술이 REST이며, 대부분의 OPEN API는 REST방식으로 지원.

 

• REST (Representational State Transfer)

      - 2000년도 로이 필딩의 박사학위 논문에 최초로 공개

      - REST는 하나의 URI는 하나의 고유한 리소스를 대표하도록 설계된다는 개념에 전송방식을 결합해서 원하는 작업을 지정한다.

      - URI + GET/POST/PUT/DELETE

      - 웹의 장점을 최대한 활용할 수 있는 아키텍쳐로써 REST를 발표

      - HTTP URI를 통해 제어할 자원을 명시하고, HTTP Method를 통해 해당 자원을 제어하는 명령을 내리는 방식의 아키텍쳐.

 

• REST의 구성

      - 자원(Resource) : URL

      - 행위(Verb) : HTTP Method

      - 표현(Representations) : JSON, XML 등으로 표현 가능

 

• 기존 Service vs REST Service

      - 기존 Service : 요청에 대한 처리를 한 후 가공된 data를 이용하여 특정 플랫폼에 적합한 형태의 View로 만들어서 반환

      - REST Service : data 처리만 한다거나, 처리 후 반환될 data가 있다면 JSON이나 XML 형식으로 전달. View에 대해서는 신경쓸 필요가 없다. >> 이러한 이유로 Open API에서 많이 사용

 

• REST

      - 기존의 전송방식과는 달리 서버는 요청으로 받은 리소스에 대해 순수한 데이터를 전송한다.

      - 기존의 GET/POST 외에 PUT, DELETE 방식을 사용하여 리소스에 대한 CRUD 처리를 할 수 있다.

      - HTTP URI을 통해 제어할 자원을 명시하고, HTTP METHOD(GET/POST/PUT/DELETE)를 통해 해당 자원을 제어한느 명령을 내리는 방식의 Architecture이다.

      - 가장 큰 단점은 딱 정해진 표준이 없어 암묵적인 표준만 정해져 있다.

        1) 하이픈(-)은 사용 가능하지만 언더바(_)는 사용하지 않는다.

        2) 특별한 경우를 제외하고 대문자 사용은 하지 않는다. (대소문자 구분함)

        3) URI 마지막에 슬래시를 사용하지 않는다.

        4) 슬래시로 계층 관계를 나타낸다.

        5) 확장자가 포함된 파일 이름을 직접 포함시키지 않는다.

        6) URI는 명사를 사용한다.

 

• REST API 설정 (Jackson library)
  - jackson-databind : 객체를 JSON 포맷의 문자열로 변환, jackson-dataformat-xml : 객체를 xml로 브라우저로 전송 

아래는 jackson-databind 라이브러리

pom.xml에 라이브러리를 추가한다.

		<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->

		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-core</artifactId>
			<version>${jackson-databind-version}</version>
		</dependency>

 

• REST 관련 Annotation

@RestController : Controller가 REST 방식을 처리하기 위한 것임을 명시

@ResponseBody : JSP 같은 뷰로 전달되는 것이 아니라 데이터 자체 전달

@PathVariable : URL 경로에 있는 값을 파라미터로 추출

@CrossOrigin : Ajax의 크로스 도메인 문제를 해결

@RequestBody : JSON 데이터를 원하는 타입으로 바인딩