[Web] REST, REST API, RESTFUL의 모든것

1. REST란?

 REST 정의

1) Representational State Transfer의 약자

 

2) 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것

 

3) WWW(월드 와이드 웹)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처

 

4) 웹에 존재하는 모든 자원(이미지, 동영상, DB자원)에 고유한 URI를 부여해 활용

   => 자원을 정의하고 자원에 대한 주소를 지정하는 방법론

 

5) REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용 

   - 웹의 장점을 최대한 활용할 수 있는 아키텍처

   - HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것

      즉, REST는 자원 기반의 구조 설계의 중심에 자원이 있고 HTTP Method를 통해 자원을 처리하도록 설계된 아키텍쳐

   - 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여

   - CRUD Operation, HTTP Method

CRUD Operation, HTTP Method
Create	POST (자원 생성)
Read	GET (자원의 정보 조회)
Update	PUT (자원의 정보 업데이트)
Delete	DELETE (자원 삭제)

 6) REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나

 

 REST의 특징

1) 클라이언트 / 서버 구조(Client-Server)

 - 자원이 있는 Server, 자원을 요청하는 Client의 구조

 - REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임

 - Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임

 - 서로 간 의존성이 줄어듦

 

2) 무상태 (Stateless)

 - HTTP는 Stateless 프로토콜이므로 REST 역시 무상태성 , 클라이언트의 Context를 서버에 저장하지 않는다.

  =>세션, 쿠키와 같은 context 정보를 신경 쓰지 않아도 되므로 구현 단순

 - Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리

  => 각 API 서버는 Client의 요청만을 단순 처리 (이전 요청이 다음 요청의 처리에 연관되면 안 됨)

       이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 가능

       Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아짐

 

 

3) 캐시 처리 가능(Cacheable)

 - 웹 표준 HTTP 프로토콜을 그대로 사용하므로, 웹에서 사용하는 기존의 인프라를 그대로 활용 가능

  => HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능 적용할 수 있음

  => HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현 가능

 - 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구됨

 - 캐시 사용을 통해 응답 시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답 시간, 성능, 서버의       자원 이용률을 향상할 수 있음

     

4) 계층화 (Layered System)

 - REST Server는 다중 계층으로 구성 될 수 있음

 - Client는 REST API Server만 호출

 - API 서버는 순수 비즈니스 로직을 수행하고 그 앞단에 사용자 인증 , 암호화 , 로드밸런싱 등을 하는 계층을 추가하여 구조상의 유연성을 줄 수 있다.

 - 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상

 - PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있음

 

 

5) 인터페이스 일관성 (Uniform Interface)

 - URI로 지정한 자원에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다. HTTP 표준에만 따른다면 모든 플랫폼에 사용이 가능하다.

 

6) 자체 표현 구조

 - 동사(Method) + 명사(URI) 로 이루어져있어 어떤 메서드에 무슨 행위를 하는지 알 수 있으며 REST API 자체가 매우 쉬워서 API 메세지 자체만 보고도 API를 이해할 수 있다

 

REST 구성 요소

 1) 자원(Resource) , URI
모든 자원은 고유한 ID를 가지고 ID는 서버에 존재하고 클라이언트는 각 자원의 상태를 조작하기 위해 요청을 보낸다. HTTP에서 이러한 자원을 구별하는 ID는 ‘Students/1’ 같은 HTTP URI 이다.

 

 2) 행위(Verb) , Method
클라이언트는 URI를 이용해 자원을 지정하고 자원을 조작하기 위해 Method를 사용한다. HTTP 프로토콜에서는 GET , POST , PUT , DELETE 같은 Method를 제공한다.

 

 3) 표현(Representation)
클라이언트가 서버로 요청을 보냈을 때 서버가 응답으로 보내주는 자원의 상태를 Representation이라고 한다. REST에서 하나의 자원은 JSON , XML , TEXT , RSS 등 여러형태의 Representation으로 나타낼수 있다.

 

 

REST 장단점

 1) 장점

 - 쉬운 사용 : HTTP 프로토콜 인프라를 그대로 사용하므로 별도의 인프라를 구축할 필요가 없다.

 -  Client-Server 역할의 명확한 분리 : 클라이언트는 REST API를 통해 서버와 정보를 주고받는다. REST의 특징인 Stateless에 따라 서버는 클라이언트의 Context를 유지할 필요가 없다.

 - 특정 데이터 표현 사용 가능 : 클라이언트는 REST API를 통해 서버와 정보를 주고받는다. REST의 특징인 Stateless에 따라 서버는 클라이언트의 Context를 유지할 필요가 없다.

 

 2) 단점 

 - 메소드의 한계 : REST는 HTTP 메소드를 이용하여 URI를 표현한다. 이러한 표현은 쉬운 사용이 가능하다는 장점이 있지만 반대로 메소드 형태가 제한적인 단점이 있다.

 - 표준이 없음 : REST는 설계 가이드 일 뿐이지 표준이 아니다. 명확한 표준이 없다.

 

 

2. RESTful이란?

 REST 형식을 따른 시스템을 RESTful이라고 지칭

 REST API를 제공하는 웹 서비스를 RESTful 하다고 표현

 

 RESTful의 목적

1)이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

 

2) RESTful API를 구현하는 근본적인 목적이 퍼포먼스 향상에 있는게 아니라, 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는게 주 동기이니, 퍼포먼스가 중요한 상황에서는 굳이 RESTful API를 구현하실 필요는 없음

 

RESTful 하지 못한 경우

예1) CRUD 기능을 모두 POST로만 처리하는 API

예2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

 

 

3. REST API란?

 

 REST API 정의

 

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

 

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

 

3) 최근 Open API, 마이크로서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공

 

 REST API 특징

1) 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있음

 

2) REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있음

 

3) REST API를 제작하면 델파이 클라이언트 뿐 아니라 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있음

 

REST API 설계 기본 규칙

1) URI는 정보의 자원을 표현
 - 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에 행위에 대한 동사 표현이 들어가면 안됨 
    => ex) GET /members/show/1 -> GET /members/1
         ex) GET /members/insert/2 -> POST /members/2

 

REST API  설계 규칙

1) 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용

=> ex) http://restapi.example.com/houses/apartments 

 

2) URI 마지막 문자로 슬래시(/ )를 포함하지 않음

 - URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 함 

 - REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않음

=> ex) https://restapi.example.com/houses/apartments/  (X)

 

3) 하이픈(- )은 URI 가독성을 높이는데 사용

 - 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높임

 

4) 밑줄(_ )은 URI에 사용하지 않는다.

 - 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

 

5) URI 경로에는 소문자가 적합

 - URI 경로에 대문자 사용은 피함

 - RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문

 

6) 파일확장자는 URI에 포함하지 않음

 - REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않음

 - Accept header를 사용

 => ex) http://restapi.example.com/members/soccer/345/photo.jpg  (X) 

 => ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

 

7) 리소스 간에는 연관 관계가 있는 경우

 - /리소스명/리소스 ID/관계가 있는 다른 리소스명

 - ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

8) :id는 하나의 특정 resource를 나타내는 고유값

 - ex) student를 생성하는 route: POST /students

 - ex) id=12인 student를 삭제하는 route: DELETE /students/12

 

 

 

참고 사이트
- https://meetup.toast.com/posts/92
- https://medium.com/@hckcksrl/rest%EB%9E%80-c602c3324196
- https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
- https://medium.com/@hckcksrl/rest%EB%9E%80-c602c3324196
- https://github.com/WeareSoft/tech-interview/blob/master/contents/network.md#rest%EC%99%80-restful%EC%9D%98-%EA%B0%9C%EB%85%90