REST API 설계 가이드

1. REST란?

1-1. REST API의 탄생

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

 

1-2. REST 구성 요소

• 자원(Resource) : URL
  • 모든 자원에는 고유한 ID가 존재하게 되고, 이 자원은 서버에 존재한다.
  • 자원을 구별하는 ID는 HTTP URL로 구분하게 된다. ex) /members/1
  • 클라이언트는 URL을 이용하여 자원을 지정하고 해당 자원에 대한 조작을 서버에 요청한다.
• 행위(Verb) : HTTP Method
  • 클라이언트는 HTTP Method(POST, GET, DELETE, PUT)를 이용하여 지정한 자원에 대한 조작을 요청한다.
• 표현(Representation of Resource)
  • 클라이언트가 서버에 자원에 대한 조작을 요청하면 서버는 이에 대한 적절한 응답(Representaions)을 보낸다.

 

2. REST의 특징

Uniform(유니폼 인터페이스)

클라이언트가 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 의미한다. 이런 한정적인 인터페이스를 사용하게 되면 URL 길이가 짧아질 뿐만 아니라 하나의 URL을 이용하여 많은 표현이 가능하다는 장점이 있다.

 

Stateless(무상태성)

작업을 위한 상태정보를 별도로 저장하거나 관리하는 일을 하지 않는다는 것을 의미한다. 이러한 이유로 세션 정보나 쿠키 정보를 별도로 저장하고 있지 않기 때문에 서버는 들어오는 요청을 단순히 처리하기만 하면 된다. 따라서 서비스의 자유도가 높아지고, 서버에서 불필요한 정보를 관리하지 않기 때문에 구현이 단순해진다.

 

Cacheable(캐시 가능)

REST의 가장 큰 특징 중 하나로, REST는 웹 표준인 HTTP를 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 사용할 수 있다. 따라서 HTTP가 가진 캐싱 기능을 적용할 수 있는데, HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag 등을 이용하면 쉽게 구현이 가능하다고 한다.

 

Self-descriptiveness(자체 표현 구조)

직관적인 표현 구조로, REST API만 보고도 쉽게 이해할 수 있다.

 

Client - Server 구조

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

 

계층형 구조

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

 

3. REST API 디자인 가이드

3-1. REST API 중심 규칙

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

1. URL은 정보의 자원을 표현해야 한다.

 

get /members/delete/1

 

위의 URL은 REST를 제대로 적용하지 않았다. URL은 정보의 자원을 표현하는데 집중해야 하므로, 행위에 대한 표현(delete)이 들어가면 안된다.

따라서, 리소스명은 동사보다 명사를 사용하는 것이 좋다.

 

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

 

DELETE /members/1

 

1번의 잘못된 URL을 HTTP Method를 통해 위와 같이 수정할 수 있다.

HTTP Method를 통해 CRUD가 가능하다.

• POST : Create, 리소스 생성
• GET : Read, 리소스 조회
• PUT : Update, 리소스 수정
• DELETE : Delete, 리소스 삭제

 

3-2. REST API 설계시 주의할 점

1. 슬래시 구분자(/)는 계층 관계를 나타낼 때 사용한다.

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

REST API는 분명한 URL을 만들어 통신을 해야하기 떄문에 혼동을 주지 않도록 URL의 마지막 경로에는 슬래시(/)를 사용하지 않는다.

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

불가피하게 긴 URL을 사용하게 된다면 하이픈(-)을 사용해 가독성을 높이는 것이 좋다.

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

밑줄은 보기 어렵거나 밑줄 때문에 다른 문자가 가려지기도 하므로 사용하지 않는 것이 좋다.

 

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

URL 경로에 대문자를 사용하게 될 경우, 대소문자에 따라 다른 리소스로 식별할 수도 있기 때문에 URL 경로는 소문자만을 이용해서 구성하는 것이 좋다. RFC 3986(URL 문법 형식)에서는 URL 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.

 

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

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI안에 포함시키지 않는다.

Accept header를 사용하도록 한다.

 

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

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

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

 

creatorId의(가 가지고 있는) products 목록 조회

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

GET : /creatores/{creatorId}/products (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

userid의 user가 좋아하는 products의 목록 조회

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

 

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

Document는 한 객체라고 표현한다면, 컬렉션은 Document의 집합, 객체들의 집합이라고 표현할 수 있다. Collection과 Document는 모두 리소스이며 URL에 표시된다. 여기서 중요한 점은 Collection은 복수로 사용한다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 복수/단수를 지켜준다면 좀 더 이해하기 쉬운 직관적인 URL을 설계할 수 있다.

 

 

3-5. HTTP 응답 상태코드

잘 설계된 REST API는 그 리소스에 대한 응답을 잘 반환해주는 것까지 포함되어야 한다. 정확한 응답 상태코드만으로도 많은 정보를 전달할 수 있고, 명확한 에러처리가 가능하다. 

 

2XX(성공)

이 클래스의 상태 코드는 클라이언트가 요청한 동작을 수신하여 이해했고 승낙했으며 성공적으로 처리했음을 가리킨다.

상태코드
200	성공, 서버가 요청을 제대로 처리함
201	작성됨, 성공적으로 요청되었으며 서버가 새 리소스를 작성함
202	허용됨, 서버가 요청을 접수했지만, 아직 처리하지 않음
203	신뢰할 수 없는 정보, 서버가 요청을 성공적으로 처리했지만 다른 소스에서 수신된 정보를 제공하고 있음

 

3xx(리다이렉션 완료)

클라이언트는 요청을 마치기 위해 추가 동작을 취해야 한다.

상태코드
301	영구이동, 요청한 페이지를 새 위치로 영구적으로 요청함
302	임시 이동, 현재 서버가 다른 위치의 페이지로 요청에 응답하고 있지만 요청자는 향후 요청 시 원래 위치를 계속 사용해야 함

 

4xx(요청 오류)

클라이언트에 오류가 있음을 나타낸다.

상태코드
400	잘못된 요청, 서버가 요청의 구문을 인식하지 못했음
401	권한 없음, 이 요청은 인증이 필요함. Unauthenticated(인증 안됨)상태
403	금지됨, 서버가 요청을 거부하는 중임
404	찾을 수 없음, 서버가 요청한 페이지(Resource)를 찾을 수 없음
405	허용되지 않는 메소드, 요청에 지정된 방법을 사용할 수 없음

 

5xx(서버 오류)

서버가 유효한 요청을 명백하게 수행하지 못했음을 나타낸다.

상태코드
500	내부 서버 오류, 서버에 오류가 발생하여 요청을 수행할 수 없음
501	구현되지 않음, 서버에 요청을 수행할 수 있는 기능이 없음
502	Bad Gatewaym 서버가 게이트웨이나 프록시 역할을 하고 있거나 또는 업스트림 서버에서 잘못된 응답을 받음
503	서비스를 사용할 수 없음, 서버가 오버로드되었거나 유지관리를 위해 다운되었기 때문에 현재 서버를 사용할 수 없음
504	게이트웨이 시간초과, 서버가 게이트웨이나 프록시 역할을 하고 있거나 또는 업스트림 서버에서 제때 요청을 받지 못했음

 

---

Reference

REST 서버, REST API란?

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

HTTP 상태 코드 - 위키백과, 우리 모두의 백과사전