REST API 를 쓰는이유

 

1. REST API의 탄생

REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었습니다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다

 

 

REST란?

 

REST는 분산 시스템 설계를 위한 아키텍처 스티일 입니다.

아키텍처 스타일이라는건 쉽게 말하면 제약 조건의 집합이라고 보면 됩니다.

 

RESTful은 무엇인가?

RESTful은 윙의 제약 조건의 집합(아키텍처 스타일, 아키텍처 원칙)을 모두 만족 하는것을 의미합니다.

REST라는 아키텍처 스타일이 있는것이고 RESTful API라는 말은 REST 아키텍처 원칙을 모두 만족하는 API라는 뜻입니다.

 

 

아키텍처란?

 

시스템 목적을 달성하기위해 시스템의 상호작용등의 시스템디자인에 대한 제약 및 설계이다 -wiki-

1. 시스템 구성 및 동작 원리
2. 시스템 구성요소에 대한 설계 및 구현을 지원하는 수준을 기술
3. 구성 요소 간의 관계 및 외부환경과의 관계 묘사
4. 요구사양 및 시스템 수명주기 고려
5. 시스템의 전체적인 최적화를 목표

한마디로 정리하면,

최적화를 목표로 두고 시스템 구성과 동작원리 그리고 시스템의 구성환경등을 설명 및 설계하는 청사진 또는 설계도라고 할 수 있습니다

 

REST가 필요한 이유는 뭘까?

1. 위에서 말한 것과 같이 분산 시스템을 위해서다.

거대한 애플리케이션을 모듈, 기능별로 분리하기 쉬워졌다. RESTful API를 서비스하기만 하면 어떤 다른 모듈 또는 애플리케이션들이라도 RESTful API를 통해 상호간에 통신을 할 수 있기 때문이다.

 

2. WEB브라우저 외의 클라이언트를 위해서다. (멀티 플랫폼)

웹 페이지를 위한 HTML 및 이미지등을 보내던 것과 달리 이제는 데이터만 보내면 여러 클라이언트에서 해당 데이터를 적절히 보여주기만 하면 된다.

예를 들어 모바일 애플리케이션으로 html같은 파일을 보내는 것은 무겁고 브라우저가 모든 앱에 있는 것은 아니기 때문에 알맞지 않았는데 RESTful API를 사용하면서 데이터만 주고 받기 때문에 여러 클라이언트가 자유롭고 부담없이 데이터를 이용할 수 있다.

서버도 요청한 데이터만 깔끔하게 보내주면되기 때문에 가벼워지고 유지보수성도 좋아졌다.

2.REST 구성

 

 자원(RESOURCE) - URI

 행위(Verb) - HTTP METHOD

 표현(Representations) 

 

3.REST 의 특징

 

1) Uniform(유니폼 인터페이스)

Uniform interface는 URI로 지정한 리소스에 대한조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.

 

2)Stateless(무상태성)

REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

 

3)Cacheable(캐시가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹 표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를ㄹ그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다. HTTP프로토콜 표준에서 사용하는 LAST-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.

 

4)Self - descriptiveness(자체표현 구조)

REST의 또 다른 큰 특징 중 하나는 REST API메세지만 보고도 이를 쉽게 이해 할 수있는 자체 표현 구조로 되어 잇다는 것입니다.

 

5)Client -Server구조

REST 서버는 API제공, 클라이언트는 사용자 인증이나 컨텍스트(세션,로그인 정보)등을 직접 관리하는 구조로 각각의 역활이확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들기게 됩니다.

 

6)계층형 구조

REST 서버는 다중 계층으로 구성될 수 있으며, 보안로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수있게 합니다.

 

4. REST API 디자인 가이드

 

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약될 수 있습니다.

 

첫 번째, URI는 정보의 자원을 표현해야 한다.

두 번째, 자원에 대한 행위는 HTTP Method(GET, POST , PUT, DELETE)로 표현한다

 

매우 중요한 두가지니 꼭 기억하도록 합시다

 

 

   4-1 REST API 중심 규칙

 

1) URI는 정보 자원을 표현해야 한다

 

   GET / members/delete/1 

 

위와 같은 방식은 REST를 제대로 적용하지 않은 URI 입니다. URI는 자원을 표현하는데 중점을 두어야합니다

 

2) 자원에 대한 행위는 HTTP Method(GET,POST,PUT,DELETE등)으로 표현

 

간략하게 수정해보면 DELETE /members/1 로 수정이 가능합니다

 

3)회원 정보를 가져오는 URI

 

 GET /members/show/1  (X)

 GET / members/1/ (O)

 

3-1) 회원을 추가할떄

 

 GET /members/insert/2 (x) -- GET 메서드는 리소스 생성에 맞지 않습니다.

POST/members/2 (o)

METHOD	역활
POST	POST를 통해 해당 URI를 요청하면 리소스를 생성합니다
GET	GET을 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옵니다
PUT	PUT을 통해 해당 리소스를 수정합니다.
DELETE	DELETE를 통해 리소스를 삭제합니다

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙입니다

 

URL은 Uniform Resource Locator

URI는 Uniform Resource Identifier (REST API의 기반) 

 

REST에서는 모든것을 리소스로 표현합니다. 그리고 그 자원은 유일한 것을 나타냅니다. 즉 Identifier 식별자라고 할 수있습니다.

과거의 웹은 식별자의 개념이 따로 필요없어서 html같은 파일을주고받고 파일의 위치를 가리키는 Locater를 사용했다고 합니다.

URI는 파일뿐만 아니라 여러 자원들도 포함되어있다고 생각하시면 됩니다.

 

4-2. URI 설계 시 주의할 점

 

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

 

http://restapi.example.com/houses/apartments

http://restapi.example.com/animals/mammals/whales

 

 

2)URI 마지막 문자로 슬래시(/)를 포함하지 안흔다.

 

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

 

http://restapi.example.com/houses/apartments/ (X)

http://restapi.example.com/houses/apartments (0)

 

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

URI를 쉽게 일고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

 

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

 

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

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이지요.

 

 

6)파일 확장자는 URI에 포함시키지 않습니다.

 

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

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 합시다.

 

    GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

 

리소스 간의 관계를 표현하는 방법

 REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용합니다.

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

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

 

만약 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법도 있습니다. 

여기서 예시는 사용자가 좋아하는 디바이스 목록을 표현해야 할 경우 다음과 같은형태로 사용될 수 있습니다.

 

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

 

 자원을 표현하는 Collection과 Document

 

Collection과 Document에 대해 알면 URI설계가 한층 더 쉬워집니다. DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해하셔도 될 것 같습니다. 컬렉션은 문서들의 집합 혹은 객체들의 집합이라고 생각할 수 있습니다. 컬렉션과 도큐먼트 모두 리소스라고 표현할 수 있으며 URI에 표현됩니다.

 

아래 예시를 보면

 

    http:// restapi.example.com/sports/soccer

위 URI을 보시면 sports라는 컬렉션과 soccer이라는 도큐먼트로 표현되고 있다고 생각하면 됩니다.

    http:// restapi.example.com/sports/soccer/players/13

 sports,players 컬렉션과 soccer과 13번선수를 의미하는 도큐먼트로 URI가 구성된걸 확인 할 수있습니다. 여기서 중요한 점은 컬렉션은 복수로 사용하고 있다는 점입니다. 조금 더 직관적인 REST API를 위해서는 컬렋ㄴ과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계 할 수 있습니다.

 

 

HTTP 응답 상태 코드

 

상태코드
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

 

상태코드
400	클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
	(로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403	유저 인증 상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
	(403 보다는 400이나 404를 사용할 것을 권고, 403체가 리소스가 존재한다는 뜻이기 때문에)
404(Not Found, 찾을 수 없음)	서버가 요청한 페이지(Resource)를 찾을 수 없다. 예를 들어 서버에 존재하지 않는 페이지에 대한 요청이 있을 경우 서버는 이 코드를 제공한다.
405	클라이 언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

 

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
	(응답 시 Location headder에 변경된 URI를 적어 줘야 합니다.)
500	서버에 문제가 있을 경우 사용하는 응답코드

 

출처:https://meetup.toast.com/posts/92

REST API 제대로 알고 사용하기 : TOAST Meetup