REST API

REST API

(Representational State Transfer)

자원을 URI로 표시하고 해당 자원의 상태를 주고 받는 것

-> Rest는 URI를 통해 자원을 표시하고, HTTP Method를 이용하여 해당 자원의 행위를 정해주며 그 결과를 받는 것이다.

 

REST에서 REST한 API를 설계하는 중심 규칙

1.URI는 자원을 표현하는 데에 집중한다

2.행위에 대한 정의는 HTTP Method(GET, POST, PUT, DELETE)를 사용한다.

Rest 기반의 규칙을 지켜 설계된 API를 Rest API 혹은 Restful API이라고 한다.

 

REST의 필요성

- 애플리케이션 분리 및 통합

- 다양한 클라이언트의 등장(web, android, iOS ...)

- 최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다.

- 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

 

REST 구성 요소

1.자원(Resource)

표현 방법 : HTTP URI

- 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재

- 자원을 식별하는 ID는 ‘/users/:userId’와 같은 HTTP URI

- Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청.

 

2.행위(Verb)

표현 방법 : HTTP Method

- HTTP 프로토콜의 Method를 사용

- HTTP 프로토콜 제공 Method -> GET, POST, PUT, DELETE

 

3.표현(Representation of Resource)

표현 방법 : HTTP Message Pay Load

- Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.

- REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타난다.

-J SON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적.

 

REST의 장단점

장점

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

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

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

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

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

 

단점

- 표준이 존재하지 않는다.

- 사용할 수 있는 메소드가 4가지 밖에 없다.(HTTP Method 형태가 제한적이다.)

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

- 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.(PUT, DELETE를 사용하지 못하고 pushState를 지원하지 않는다.)

 

 

REST 특징

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

REST API의 가장 큰 특징 중 한가지. 각 영영이 확실하게 분리되어 있다.

자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client

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

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

-> 서로 간 의존성이 줄어든다.

 

2.Stateless(무상태)

HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.(서버에서 요청을 위해 따로 상태정보를 저장, 관리하지 않는다.)

Client의 context를 Server에 저장하지 않는다. 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 된다.

Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다. 각 API 서버는 Client의 요청 만을 단순 처리한다.

-> 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않아 구현이 단순해진다.

 

 

3.Cacheable(캐시 처리 가능)

웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.

즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.

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

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

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

 

4.Layered System(계층형 구조)

Client는 REST API Server만 호출한다.

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

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

또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.

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

 

5. 자체 표현 구조(Self-descriptiveness)

REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다.
JSON, XML -> 구조를 정의 할수 있다.

 

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

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

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

특정 언어나 기술에 종속되지 않는다.

 

 

REST API 설계 예시

API(Application Programming Interface)

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

 

REST API의 정의

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

OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처), 모바일API, 서비스API 등 대부분은 REST API를 제공하고 개발한다.

기본 규칙 resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다. resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다. resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다. resource의 스토어 이름으로는 복수 명사를 사용해야 한다.   자원에 해당하는 행위는 HTTP Method로 표현한다.

설계 규칙 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.   URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.    하이픈(- )은 URI 가독성을 높이는데 사용한다.    밑줄(_ )은 URI에 사용하지 않는다.    URI 경로에는 소문자 사용.(대문자 사용은 피한다)    파일확장자는 URI에 포함하지 않는다.

 

예시

HTTP Method	역할	예시
GET	GET을 동해 해당 리소스를 조회합니다.	/users/255	고유 id가 255 인 회원 조회
POST	POST를 통해 해당 URL를 요청하면 리소스를 생성합니다.	/users	회원 생성
PUT	PUT을 통해 해당 리소스를 수정합니다.	/users/255	고유 id가 255 인 회원 수정
DELETE	DELETE를 통해 해당 리소스를 삭제합니다.	/users/255	고유 id가 255 인 회원 삭제

Good

GET /users : 회원 list를 조회한다.

GET /users/:id : 회원 조회

POST /users :  회원 생성

PUT /users/:id : 회원 수정

DELETE /users/:id : user 삭제

 

Bad

GET /users/list : 회원 조회

POST /user/update : 회원 수정

POST /userUpdate : 회원수정

POST /user/delete : 회원 삭제

POST /userDelete:  회원 삭제

 

참고 HTTP 상태 코드

https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

 

상태 코드