[REST] REST 란?

REST 에 대해 공부를 하다가, RESTful API 란 무엇일까를 생각하게 됐다. REST 하게 프로젝트도 진행했고, 프로젝트 진행을 위해 공부를 했던 것 같은데 정확하게 REST 라는 것이 어떤 의미인지는 알지 못하고, 'URI 는 자원을 명시하도록 하고 HTTP Method (POST, GET, PUT, DELETE) 를 통해 CRUD 를 정의한다.' 라고만 알고 있어 REST 가 어떤 의미를 갖는지, REST API 는 무엇인지 자세히 공부할 필요성을 느끼게 됐다.

 

REST 란?

---

REST 는 REpresentational State Transfer 의 약자로, 위키에서는 이 용어를 World Wide Web 아키텍처의 설계 / 개발을 가이드하기 위해 만들어진 소프트웨어 아키텍처 스타일이라 정의한다.

REST 는 일련의 원칙들을 정의해서 웹 설계 및 개발 시 가이드라인을 주고 있는데, 이러한 원칙을 잘 지켜 개발된 API 를 RESTful API 라 부른다.

 

RESTful API 는 다음의 구성으로 이루어져있다.

• URI - 자원 (Resource)
• HTTP Method - 행위 (Verb)
• 표현 (Representation)

 

REST 의 특징

---

1. 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. Hierarchical System

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가함으로써 구조상의 유연함을 갖출 수 있고 프록시, 게이트웨이와 같은 네트워크 기반의 중간 매체를 사용할 수 있게 한다.

 

REST API 디자인 가이드

---

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

1. URI 는 요청한 정보의 자원을 표현해야 한다.
2. 자원에 대한 행위는 HTTP Method (POST, GET, PUT, DELETE) 로 표현한다.

 

1. REST API 중심 규칙

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

GET /members/delete/1

위의 방식은 REST 의 원칙을 제대로 적용하지 않은 API 이다. URI 는 자원을 표현하는 데 중점을 두어야 한다. delete 와 같은 행위에 대한 표현이 URI 에 들어가선 안 된다.

 

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

위의 잘못된 URI 를 HTTP Method 를 적용해 표현하면 다음과 같이 표현할 수 있다.

DELETE /members/1

정보를 가져올 때는 GET, 정보 추가 시의 행위를 표현할 때는 POST Method 를 사용해 표현한다.

 

※ HTTP Method 의 알맞은 역할

POST, GET, PUT, DELETE 이 4가지의 메소드를 사용해 CRUD 를 표현할 수 있다.

METHOD	Description
POST	특정 URI 를 요청하면 리소스를 생성한다.
GET	리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
PUT	해당하는 리소스를 수정한다.
DELETE	리소스를 삭제한다.

위와 같은 식으로, URI 는 자원을 표현하는 데 집중하고 행위에 대한 정의는 HTTP Method 를 통해 표현하는 것이 RESTful API 를 설계하는 중심 규칙이다.

 

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	(O)
http://restapi.example.com/houses/apartments/	(X)

 

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

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

 

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

글꼴에 따라 다르긴 하지만, 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지는 경우도 존재한다. 이런 문제를 피하기 위해 밑줄 대신 하이픈을 사용하는 것이 권장된다.

 

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

URI 경로에 대문자를 사용하는 것은 피하도록 해야 한다. 위에서 언급했듯, URI 가 달라지면 리소스가 달라지는데 대소문자에 따라 URI 가 달라져 다른 리소스로 인식하기 때문이다.

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

 

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

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

RESTful API 는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. 대신 다음과 같이 Accept Header 를 사용해 API 를 호출한다.

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

 

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

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 방법으로 표현한다. (/ 리소스명 / 리소스 ID / 연관 관계가 있는 다른 리소스명)

GET /users/{userid}/devices		(일반적으로 'has' 의 관계를 표현할 때)

만약에 리소스 간 연관 관계가 단순 소유 관계가 아닐 경우, 이를 서브 리소스에 명시적으로 표현할 수 있는 방법이 있다. 예를 들어, 사용자가 '좋아하는' 디바이스 목록을 표현해야 할 경우 다음과 같이 표현할 수 있다.

GET /users/{userid}/likes/devices	(관계명이 애매하거나 복잡한 관계를 표현하고자 할 때)

 

4. 자원을 표현하는 Collection 과 Document

Collection 과 Document 에 대한 이해는 URI 설계를 더 쉽게 할 수 있도록 도와준다. 도큐먼트는 단순히 문서로 이해할 수도 있고, 하나의 객체로 이해할 수도 있다. 컬렉션은 문서들의 집합, 객체들의 집합이라고 생각하면 이해하는 데 편할 수 있다. 컬렉션과 도큐먼트는 모두 리소스라 표현할 수 있으며 URI 에 표현된다. 다음의 예를 살펴보자.

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

위의 URI 를 보면, sports 라는 컬렉션과 soccer 라는 도큐먼트를 표현하고 있다. 좀 더 자세한 예를 보자.

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

sports, players 컬렉션과 soccer, 13 (13번 선수) 를 의미하는 도큐먼트로 URI 가 이루어진다. 여기서 중요한 점은, 컬렉션은 URI 에서 복수로 표현하고 있다는 점이다. 좀 더 직관적인 REST API 를 설계하기 위해 컬렉션과 도큐먼트를 사용할 때 단수/복수 를 잘 지킨다면 좀 더 이해하기 쉬운 URI 를 설계할 수 있다.

 

5. HTTP 응답 상태 코드

마지막으로, 응답 상태코드를 간단히 살펴보자. 잘 설계된 RESTful API 는 URI 만 잘 설계된 것이 아니라 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다. 정확한 응답의 상태코드만으로도 많은 정보를 전달할 수 있기 때문에 응답의 상태코드 값을 명확히 하는 것은 생각보다 중요하다. 응답에 대한 상태 코드로 200 과 4XX 정도의 코드만을 사용하고 있다면 처리 상태/결과에 대한 더 명확한 상태 코드값을 사용하는 것이 필요하다.

 

주로 사용하는 몇 가지의 상태코드는 다음과 같다. 상태 코드들에 대한 자세한 정보는 여기서 확인할 수 있다.

Status Code	Description
200 OK	클라이언트의 요청을 정상적으로 수행함
201 Created	클라이언트가 요청한 리소스가 정상적으로 생성됨
301 Moved Permanently	클라이언트가 요청한 리소스에 대한 URI 가 변경됨 (응답 시 Location Header 에 변경된 URI 를 명시)
400 Bad Request	클라이언트의 요청이 부적절함
401 Unauthorized	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청함 (예: 로그인하지 않은 유저가 로그인했을 때 요청 가능한 리소스를 요청)
403 Forbidden	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청함 (403 보다는 400 이나 404 의 사용을 권장. 403 응답 자체가 해당 리소스가 존재한다는 의미를 갖기 때문)
404 Not Found	클라이언트가 요청한 리소스가 존재하지 않음
405 Method Not Allowed	클라이언트가 요청한 리소스에서 사용 불가능한 메소드를 사용
500 Internal Server Error	서버 내부적인 문제로 정상적인 처리가 불가능함

 

#Reference.

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