REST란?

들어가기 전

해당 페이지의 정보는 EUID의 REST API 키노트의 정보를 옮겨온 것입니다.

RESTAPI

애플리케이션(Application)통신

오늘날 대부분의 애플리케이션은 상호 운용성을 기본 기능으로 제공해야 합니다. 특정 순간에 애플리케이션은 다른 애플리케이션 (예: 웹애플리케이션과 통신하는 모바일 애플리케이션)과 통신합니다.

따라서 모든 애플리케이션이 기본 운영 체제 및 프로그래밍 언어에 의존하지 않고(독립적이다.), 다른 애플리케이션과 통신 할 수 있어야 합니다. 웹 서비스는 이러한 애플리케이션을 만드는데 사용됩니다.

웹서비스(WebService)

웹 서비스는 애플리케이션과 시스템이 인터넷을 통해 데이터를 교환하는데 사용하는 표준 및 프로토콜 모음입니다. 웹 서비스는 모든 프로그래밍 언어로 작성될 수 있으며 운영 체제에 독립적입니다. (모든 환경에서 돌아간다.)

예를들어 Linux서버에서 실행되는 PHP로 작성된 애플리케이션은 Java를 사용하고 Android 운영 체제에서 실행되는 Android 애플리케이션과 통신할 수 있습니다.

REST란?

REST는 REpresentational State(상태, 데이터, 리소스) Transfer라는 용어의 약자로서 2000년도에 로이 필딩(RoyFielding)의 박사학위 논문에서 최초로 소개되었습니다.

로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.

REST 클라이언트(Client) ⇔ 서버(Server)의 동작을 제어하는 기본특성 및 프로토콜을 제공하는 상태(state) 비 저장 소프트웨어 아키텍처

RESTfull 서비스

RESTful 웹 서비스 (RESTful API 라고도 함)는 HTTP 프로토콜과 REST의 원칙을 사용하여 구현 된 웹 서비스입니다. 리소스(자원, Resource)의 집합은 유효한 하이퍼텍스트 표준인 모든 유효한 인터넷 미디어 유형이 될 수 있는 표준화된 형식(일반적으로 XML 또는 JSON)으로 표현됩니다.

RESTful API를 사용하는 이유

RESTfulAPI는 애플리케이션의 성능, 확장성, 단순성, 수정 가능성, 가시성, 이식성 및 안정성을 향상시키기 위해 인터넷을 통해 애플리케이션을 분산 및 독립적으로 만드는데 사용됩니다.

가장 인기있는 모든 웹 사이트와 소셜 미디어는 RESTful API를 제공합니다.

국내

카카오 알림톡 API
SK T map 교통정보 API
자전거 편의시설 공간정보 API
잡코리아 API
카카오 링크 API
기상청 날씨 API
SK 멜론 음악 정보 검색 API

해외

Facebook REST API
Twitter REST API
Google REST API
SoundCloud API

REST를 구성하는 것들

자원 (RESOURCE) - URI
행위 (Verb) - HTTP 메서드 (GET / POST / PUT / DELETE 등)
표현(Representations)

REST특징

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

UniformInterface는 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 가지로 요약할 수 있습니다.

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

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

다른 것은 다 잊어도 위 내용은 꼭 기억하시길 바랍니다!

1.REST API 중심규칙

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

리소스 이름은 동사보다는 명사를 사용

GET/members/delete/1

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

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

위의 잘못된 URI를 HTTPMethod를 사용해 올바르게 수정하면 다음과 같아져야 합니다.

DELETE/members/1 DELETE/members/1

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

회원정보를 가져오는URI

GET/members/show/1 (x)
GET/members/1      (o)

회원을추가할때

GET/members/insert/2 (x) //GET 메서드는 리소스 생성에 적합하지 않습니다.
POST/members/2       (o)

HTTP 메서드의 각 역할

HTTP 메서드(GET,POST,PUT,DELETE)를 통해 CRUD를 할 수 있습니다.

HTTP 메서드

CRUD

역할

POST

Create

리소스 생성 (쓰기)

GET

Read

리소스 조회 (읽기)

PUT

Update

리소스 수정 (쓰기)

DELETE

Delete

리소스 제거 (삭제)

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

2.URI 설계 시, 주의할 점

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

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

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

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

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

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

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

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(‑)을 사용하는 것이 좋습니다. (가독성)

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

RFC 3986 is the URI(Unified Resource Identifier)Syntax document

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

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

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

GET/members/soccer/345/photoHTTP/1.1Host:restapi.example.comAccept:image/jpg

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

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

/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있습니다.

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

4.자원을 표현하는 Colllection과 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(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 됩니다. 여기서 중요한 점은 컬렉션은 복수로 사용하고 있다는 점입니다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있습니다.

5.HTTP 응답 상태 코드

마지막으로 응답 상태 코드를 간단히 살펴보도록 하겠습니다. 잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 합니다. 정확한 응답의 상태 코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태 코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이 될 수도 있습니다. 혹시 200이나 4XX 관련 특정 코드 정도만 사용하고 있다면 처리상태에 대한 좀 더 명확한 상태 코드 값을 사용할 수 있기를 권장하는 바입니다. 상태 코드에 대해서는 몇 가지만 정리하도록 하겠습니다.

상태 코드

설명

200

클라이언트(Client)의 요청이 정상적으로 수행된 경우 응답 코드

201

클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성된 경우 응답 코드 (POST를 통한 리소스 생성 작업 시)

상태 코드

설명

301

클라이언트가 요청한 리소스에 대한 URI이 변경되었을 때 사용되는 응답 코드 (응답 시 Location header에 변경된 URI를 적어줘야 함)

상태 코드

설명