REST API의 탄생/구성/특징 등

REST API의 탄생

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

왜 REST에 대한 관심을 갖게 되었을까요?

 - 프론트엔드(Front-End)와 백엔드(Back-End)가 분리되기 시작

- 새로운 서비스 개발을 위해 개발작업 진행

- JSON 형태로 데이터를 제공하는 API를 제공하자고 동의

- RequestMethod(HTTP : GET, POST, PUT, DELETE)와 URL을 이용한 정의

- View 영역이 포함되지 않은 서버사이드(Server-side) 개발을 진행

 - 멀티플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색

- 웹 + 모바일 웹

- 아이폰, 안드로이드

- 그 외

REST

 - REST는 서비스 지향 구조인 SOAP과 달리 자원지향구조(ROA : Resource Oriented Architecture)로 웹 사이트의 컨텐츠(Text, 이미지, 동영상), DB의 내용 등을 전부 하나의 자원으로 파악하여 각 자원의 고유한 URI(Uniform Resource Identifier)를 부여하고,, 해당 자원에 대한 CRUD(Create - 생성, Read - 읽기, Update - 수정, Delete - 삭제) 작업을 HTTP의 기본 명령어인 POST, GET, PUT, DELETE를 통해서 처리

Method, CRUD, SQL 비교와 역할

Method	CRUD	SQL	역할
POST	Create	INSERT	POST를 통해 해당 URI를 요청하면 리소스를 생성함
GET	Read	SELECT	GET을 통해 해당 리소스를 조회. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옴
PUT	Update	UPDATE	PUT을 통해 해당 리소스를 수정
DELETE	Delete	DELETE	DELETE를 통해 리소스를 삭제

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

REST API

 - REST 구조 스타일에 적합한 Web API를 뜻함

 - 'REST API'를 제공하는 웹 서비스를 'RESTful' 하다라고 할 수 있음

REST API 구현 사례

 - 네이버 개발자센터

 - 다음

 - Google Developer

 - Twitter Develpoer

REST API 정보 제공 방식

 - XML

 - JSON

 - RSS

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, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게합니다.

REST API 디자인 가이드

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

- URI는 정보의 자원을 표현해야 한다.

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

이 두가지 규칙은 꼭 기억하셔야 합니다.

1. URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 하기때문에 delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

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

위의 잘못된 URI를 HTTP Method를 통해 수정해 보면

DELETE /members/s

로 수정할 수 있습니다.

회원정보를 가져올때는 GET, 회원 추가 시의 행위를 표현하고자 할때는 POST Method를 사용하여 표현합니다.

회원정보를 가져오는 URI

GET /members/show/1    ( x ) 

GET /members/1           ( o ) 

회원을 추가할 때

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

POST /members/2          ( o ) 

URI 설계 시 주의할 점

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

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

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

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

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

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

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

- 대소문자에 따라 다른 리소스로 인식하기 때문에 URI경로에 대문자 사용은 피하도록 합니다. 

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

**

조만간 Spring을 이용해서 RESTful 웹 서비스 예제를 작성해서 포스팅할게요.