REST API란 무엇일까?

 REST(Representational State Transfer)는 로이 필딩(Roy Fielding)의 박사학위 논문에서 처음 소개되었다. 발표 당시 웹이 HTTP의 설계상 우수성을 제대로 사용하지 못하고 있는 상황을 보고 웹의 장점을 최대한 활용할 수 있는 아키텍처로서 REST를 소개하였고 이는 HTTP 프로토콜의 의도에 맞게 디자인하도록 유도하고 있다. REST의 기본 원칙을 성실히 지킨 서비스 디자인을 RESTful이라고 한다.

 

👾 REST API 구성

 REST API는 자원(Resource), 행위(Verb), 표현(Representations)의 3가지 요소로 구성된다. REST는 자체 표현 구조(Self-descriptiveness)로 구성되어 REST API만으로 요청을 이해할 수 있다.

구성요소	내용	표현 방법
Resource	자원	HTTP URI
Verb	자원에 대한 행위	HTTP Method
Representations	자원에 대한 행위의 내용	HTTP Method

 

👾 REST API 설계 중심 규칙

 REST에서 가장 중요한 기본적인 규칙은 두 가지이다. 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의한다.

 

1. URI는 웹에서 사용되는 데이터나 자원(Resource)을 표현하는 데 집중한다.

# bad
GET /getTodos/1
GET /todos/show/1

# good
GET /todos/1

 → 리소스명은 동사보다는 명사를 사용하고, URI는 자원을 표현하는데 중점을 둔다.

 → get이나 show와 같은 행위에 대한 표현이 들어가서는 안된다.

 

2. HTTP Method를 통해 행위에 대한 정의를 한다.

# bad
GET /todos/delete/1

# good
DELETE /todos/1

 → 자원에 대한 행위는 HTTP 메서드(GET, POST, PUT, DELETE 등)으로 표현한다.

 

❗HTTP Method

CRUD 구현을 위한 5가지 메서드

Method	Action	역할	페이로드
GET	index/retrieve	모든/특정 리소스를 조회	X
POST	create	리소스를 생성	O
PUT	replace	리소스의 전체를 교체	O
PATCH	modify	리소스의 일부를 수정	O
DELETE	delete	모든/특정 리소스를 삭제	X

 

👾 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. Layered System (계층형 구조)

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

 

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

 

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

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

 

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

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

 

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

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

 

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

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

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

 Accept header를 사용한다.

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

 

👾 REST API를 디자인하는 방법 (REST 성숙도 모델)

 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리처드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

 리처드슨의 REST 성숙도 모델을 구조화하면 다음과 같다.

출처: 코드스테이츠 SEB

 REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다.

 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했다. 그러나 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API라고도 부른다.

 

 

 ↓ REST 성숙도 모델을 자세히 알고 싶다면, 아래 포스팅을 참고하면 될 것 같다.

REST 성숙도 모델

 

---

자료출처: Poiemaweb, Inpa Dev

✏️ 공부하며 정리한 내용입니다. 잘못된 정보나 더 공유할 내용이 있으면 댓글로 알려주세요!
💬 ( REST의 특징과 URI 설계 시 주의할 점의 일부분은 아직 잘 이해가 되지 않아서, 우선 기록만 해둡니다. )

읽어주셔서 감사합니다 😊