RESTful API

프론트엔드와 백엔드 간의 소통이 원활해지려면 상호간의 엔드포인트인 API가 중요하다. 얼마나 명확하고 직관적이게 작성하냐에 따라 이해도가 달라지기 때문이다.

 

그래서 우리는 RESTful하게, 즉, 일종의 약속을 통해 API가 어떤 동작을 수행하는지 명확하게 작성하려고 노력해야한다.

 

여기서 REST란 Representational State Transfer의 약자로 2000년, 로이 필딩(Roy Fielding)이 박사학위 논문에 소개된 API 아키텍처 가이드라인이다. 현재까지도 이 가이드라인을 지키기 위해 많은 사람들이 노력하고 있다.

가이드라인이기 때문에 안지킨다고 해서 에러가 발생하거나 그러진 않지만 개발자들이 API를 접했을 때 RESTful하게 작성되었을 것이라 생각하고 API를 대하기 때문에 지키려고 노력하자.

 

REST API의 구성

• REST : 리소스가 어떠한 상태로 표현되는가?
• URI : 어떤 리소스인가?
• HTTP 메소드 : 어떠한 동작인가?

REST API는 REST 가이드라인을 지키며 리소스가 어떠한 상태인지를 나타내며 URI와 HTTP 메소드를 통해 리소스를 어떠한 방식으로 처리할 것인지를 명시한다.

 

REST API 특징

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

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

 

2. Stateless(무상태성)

REST는 무상태성을 가진다. 상태정보 등을 따로 저장하고 관리하지 않는다. 때문에 API 서버는 들어오는 요청만 처리하면 된다. 이로인해 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

 

3. Cacheable(캐시 가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기준 웹표준을 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다.

 

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

REST API 메시지만 보고 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.

 

5. 계층형 구조

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

 

REST API 디자인 가이드

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

• URI는 정보의 자원을 표현해야 한다.
• 자원에 대한 행위는 HTTP 메소드(GET, POST, PUT, DELETE)로 표현한다.

REST API 중심 규칙

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

GET /users/delete/1

delete와 같이 행위를 사용하여 표현해서는 안된다.

 

2. 자원에 대한 행위는 HTTP method 사용

DELETE users/1

위의 GET 메소드를 DELETE를 사용하여 표현하였다.

 

여기서 GET 메소드는 정보를 가져올 때 사용하며 DELETE는 리소스를 제거할 때 사용한다.

 

HTTP 메소드에는 여러가지가 있지만 CRUD를 할 수 있는 대표적인 4가지만 알아보자.

• GET : 리소소를 조회한다. 해당 리소스를 조회하고 세부사항도 확인할 수 있다.
• POST : 리소스를 생성한다.
• PUT : 리소스를 수정한다.
• DELETE : 리소스를 제거한다.

URI 설계 시 주의사항

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

GET users/2/image
GET animal/mammals/cats

 

2. URI 마지막 문자로 / 를 포함하지 않는다.

REST API는 분명한 URI를 만들어 통신을 해야하기 때문에 혼동을 주지 않도록 URI의 마지막에는 / 를 사용하지 않는다.

GET users/2/image/ (X)
GET users/2/image  (O)

 

3. 하이픈(-)은 URI의 가독성을 높이기 위해 사용

불가피하게 긴 URI를 사용하는 경우 하이픈(-)을 사용해 가독성을 높일 수 있다.

GET users/2/profile-image

 

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

밑줄은 보기어렵거나 밑줄 때문에 문자가 가려지기도 한다. 그래서 밑줄 대신 하이픈(-)을 사용

 

5. URI 경로에는 소문자를 사용

대소문자에 따라 다른 리소스로 인식되기 때문에 소문자를 사용해야한다.

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

 

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

GET users/2/image.jpg (X)

파일 확장자는 Accept Header를 사용하여 나타낸다.

 

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

REST 리소스 간에 연관관계가 있을 수 있다.

GET users/{userid}/toys (일반적으로 has 소유관계를 표현할 때)

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

GET users/{userid}/likes/toys

likes를 이용하여 '좋아하는'을 표현할 수 있다.

 

[참고]

https://meetup.nhncloud.com/posts/92

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