REST API

REST

자원을 이름(자원의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다. https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

• 자원 - 해당 소프트웨어가 관리하는 모든것
• 자원의 표현 - 그 자원을 표현하기위한 이름(DB의 학생 정보가 자원일 때, ‘students’를 자원의 표현으로 정한다.)
• 상태 전달 - 데이터가 요청되어지는 시점에서 자원의 상태를 전달한다. (json, xml이 일반적)

rest는 기본적으로 웹의 기존기술과 http프로토콜을 그대로 활용하기때문에 웹은 장점을 최대한 활용할수있는 아키텍처 스타일이다.

rest는 네트워크상에서 client와 server사이의 통신방식중 하나이다.

 

---

REST의 구체적인 개념

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. 즉, REST는 자원 기반의 구조설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다. 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

 

CRUD Operation

Create : 생성(POST)

Read : 조회(GET)

Update : 수정(PUT)

Delete : 삭제(DELETE)

HEAD: header 정보 조회(HEAD)

Patch : 수정(일부)

---

REST의 장단점

장점

HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.

HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.

HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.

REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.

여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.

서버와 클라이언트의 역할을 명확하게 분리한다.

 

단점 표준이 존재하지 않는다.

HTTP Method 형태가 제한적이다.

브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.

---

REST 구성 요소

• 자원(Resource): URI 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다. 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다. Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
• 행위(Verb): HTTP Method HTTP 프로토콜의 Method를 사용한다. HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.
• 표현(Representation of Resource) Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다. REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다. JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

---

REST 특징 (이 6개 조건을 잘 지키는 서비스 디자인을 restful하다 라고하는것)

1. Server-Client(서버-클라이언트 구조)
   • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다. REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다. Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다. 서로 간 의존성이 줄어든다.
2. Stateless(무상태)
   • Client의 context를 Server에 저장하지 않는다. (즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.) Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. (각 api서버는 client 요청만 단순처리, 이전 요청이 다음요청에 영향안줌)
3. cacheable(캐시처리가능)
   • 웹표준 http프로토콜을 그대로 사용하므로 캐싱기능적용가능. 응답시간, 성능, 서버의 자원 이용률 향상
4. layered system(계층화)
   • client는 REST API SERVER만 호출 / REST API는 다중계층으로 구성가능(API SERVER는 순수 비즈니스로직만 수행하고 그 앞단에 보안, 로드밸런싱 ..)
5. code-on-demand(optional)
6. uniform interface(인터페이스 일관성)
   • URI로 지정한 resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행. http표준 프로토콜을 따르는 모든 플랫폼에서 사용가능(독립적)

---

API - 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것

REST API - REST기반으로 서비스 API를 구현한것

 

REST API 설계 기본 규칙

1. URI는 정보의 자원을 표현해야 한다. resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다. resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다. resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다. resource의 스토어 이름으로는 복수 명사를 사용해야 한다. (Ex) GET /Member/1 -> GET /members/1)
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다. URI에 HTTP Method가 들어가면 안된다. (Ex) GET /members/delete/1 -> DELETE /members/1) URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.) Ex) GET /members/show/1 -> GET /members/1 Ex) GET /members/insert/2 -> POST /members/2 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.) Ex) student를 생성하는 route: POST /students Ex) id=12인 student를 삭제하는 route: DELETE /students/12
3. 슬래시 구분자(/)는 계층관계를 나타내는데 사용한다.
4. Ex) http://restapi.example.com/houses/apartments
5. URI 마지막 문자로 슬래시(/)를 포함하지않는다.
6. 불가피하게 긴 URI경로는 하이픈(-)을 사용해서 가독성을 높인다.
7. 밑줄(_)은 URI에 사용하지않는다.
8. URI경로는 소문자로 하도록한다.
9. 파일확장자는 URI에 포함하지않는다.

REST API설계 예시

 

 

참고 응답상태코드

1xx : 전송 프로토콜 수준의 정보 교환
2xx : 클라어인트 요청이 성공적으로 수행됨
3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx : 클라이언트의 잘못된 요청
5xx : 서버쪽 오류로 인한 상태코드

---

RESTFul

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어이다. ‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다. RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다. 즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다. (위의 6개를 다 따르면 restFul하다는거)

 

RESTful의 목적 이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것 RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

 

RESTful 하지 못한 경우 Ex1) CRUD 기능을 모두 POST로만 처리하는 API Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

---

스프링은 3버전부터 @ResponseBody 어노테이션을 지원하면서 본격적으로 rest방식 처리 가능

3버전까지는 컨트롤러는 @Controller 어노테이션만을 사용해서 처리했고, 화면처리를 담당하는 jsp가 아닌 데이터 자체를 서비스하려면 해당 메소드나 리턴타입에 @ResponseBody를 붙여서 작업

하지만, 4버전부터는 @RestController어노테이션이 추가됨. 기능자체는 똑같지만, 컨트롤러 자체의 용도를 지정한다는 점이 다름

 

@RestController = @Controller + @ResponseBody ← 해당 컨트롤러의 모든 뷰처리가 jsp가 아님을 의미. 즉, 데이터를 서비스함

스프링에서 제공하는 ResponseEntity타입은 개발자가 직접 결과데이터 + HTTP상태코드를 한꺼번에 보낼수있음

return new ResponseEntity<>(list, HttpStatus.BAD_REQUEST);