[Spring] Rest API 개념 정리

🔎 OPEN API?

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

대부분의 OPEN API는 REST방식으로 지원된다.

 

🔎 REST API?

REST는 'Representational State Transfer'의 약어로,

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

 

HTTP URI를 통해 제어할 자원(Resource)를 명시하고, HTTP Method(GET, POST, PUT, DELETE)을 통해

해당 자원(Resource)를 제어하는 명령을 내리는 방식의 아키텍처이다.

 

✔️REST 구성.

▪️ 자원 (Resource) - URI

▪️ 행위 (Verb) - HTTP Method

▪️ 표현 (Representations)

 

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

리소스는 JSON, XML과 같은 여러가지 언어로 표현할 수 있다.

 

✔️ 기존 Service와 REST Service

▪️ 기존 Service : 요청에 대한 처리를 한 후 가공된 data를 이용하여 특정 플랫폼(Python, Java, C...)에 적합한 형태의 View로 만들어서 반환.

▪️ REST Service : data 처리만 한다거나, 처리 후 반환될 data가 있다면 JSON이나 XML 형식(언어에 종속적이지 않음)으로 전달. View에 대해서는 신경 쓸 필요가 없다. ==> 이러한 이유로 Open API에서 많이 사용.

 

📝 REST.

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

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

▪️ HTTP URI를 통해 제어할 자원(Resource)을 명시하고, HTTP METHOD(GET/POST/PUT/DELETE)를 통해 

해당 자원을 제어하는 명령을 내리는 방식의 Architecture이다.

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

 - 언더바(_)는 사용하지 않는다. (가독성)

 - 특별 경우 제외하고 대문자 사용하지 않는다.

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

 - 슬래시(/)로 계층 관계를 나타낸다.

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

 - URI는 명사를 사용한다.

 

 

✔️ REST 관련 Annotation.

▪️ @RestController

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

▪️ @ResponseBody

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

▪️ @PathVariable

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

▪️ @CrossOrigin

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

  => 이 컨트롤러를 아무나 접속하면 안되는 경우, 누구한테만 연결을 해주겠다 하는 경우 @CrossOrigin(url설정)을 하여

이 url에 해당하는 곳은 접근할 수 있지만 이것이 아닌 애들은 접근을 못하도록 한다. (보안적 측면)

▪️ @RequestBody

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

   => 기존에는 Dto를 받는데 Dto라 설정해놓고 저쪽에서 넘겨주는 파라미터 이름과 Dto가 가지고 있는 프로퍼티 이름을 똑같이 맞춰주면 알아서 들어간다. 이번에는 파라미터로 넘어오는게 아니라 Ajax의 JSON 형태로 넘어온다. json 형태로 넘어온 값들을 dto에다 받을 때 @RequestBody해서 파라미터 이름이 아니라 Json Object로 보내준 값을 Dto의 파라미터로 매핑시켜주는 역할을 한다.