REST, REST API, RESTful API

개요

REST, REST API, RESTful 특징

---

1. REST 란?

REST는 REpresentational State Transfer 의 약자입니다.

REST의 정의

REST는 자원을 이름(URI)으로 표현하고, 해당 자원에 대한 행위(HTTP Method)를 통해 상호작용하는 아키텍처 스타일입니다.

 

URI와 URL의 차이점?
URL은 Uniform Resource Locator로 인터넷 상 자원의 위치를 의미하고, 
URI는 Uniform Resource Identifier로 인터넷 상의 자원을 식별하기 위한 문자열 구성으로,
URI는 URL을 포함하게 됨.
즉, URI가 URL보다 포괄적인 범위라고 할수 있습니다.

 

REST의 특징

1. 클라이언트 - 서버 구조 (Server - Client)

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client
  • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
  • Client: 사용자 인증이나 context(세션, 로그인 정보)등을 직접 관리하고 책임진다.
• 서로 간 의존성이 줄어든다

2. 무상태성 (Stateless)

• HTPP 프로토콜은 Stateless Protocol이므로 REST역시 무상태성을 갖는다.
• Client의 context를 Server에 저장하지 않음
  • 즉, 세션과 쿠기와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
• Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
  • 각 API 서버를 Client의 요청만을 단순 처리 한다.
  • 즉, 이전 요청이 다음 요청의 처리에 연관되어사는 안된다.
  • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
  • Server의 처리 방식에 일관성을 부여하고 부담히 줄어들며, 서비스의 자유도가 높아진다.

3. 캐시 처리 가능(Cscheable)

• 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
  • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
• 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.

4. 계층 구조 (Layered System)

• Client는 REST API Server만 호출한다.
• REST Server는 다중 계층으로 구성될 수 있다.
  • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상 유연성을 줄수 있다.
  • 로드 밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
• PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

5. 인터페이스 일관성 (Uniform Interface)

• URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • 특정 언어나 기술에 종속되지 않는다.

6. 코드 온 디맨드(Optional)

• Server로 부터 스크립트를 받아서 Client에서 실행한다.
• 반드시 충족할 필요는 없다.

---

 

REST의 구성 요소

1. 자원 (Resource) 

REST에서 자원은 정보의 단위이며, 일반적으로 URI를 통해 표현됨.

• /user -> 사용자 목록이라는 자원
• /user/1 -> ID 가 1인 사용자 라는 자원

자원은 명사 형태로 표현하며, 고유한 URI로 식별됩니다.

 

2. 행위 (Verb, Method)

HTTP 메서드를 이용해 자원에 무엇을 할 것인지(행위)를 정의

메서드	설명
GET	(Read) 자원 조회
POST	(Create) 자원 생성
PUT	(Update) 자원 전체 수정
PATCH	(Update) 자원 일부 수정
DELETE	(Delete) 자원 삭제

 

3. 표현 (Representation)

클라이언트와 서버가 자원을 주고받을 때는 자체 데이터가 아닌 자원의 표현을 전달함.

• 일반적인 표현 형식
  • JSON
  • XML

---

2. REST API 란?

REST API 의 정의

REST API는 위에서 설명한 REST 원칙을 기반으로 만들어진 인터페이스

 

REST API 의 특징

• REST API의 가장 큰 특징은 각 요청이 어떤 동작이나 정보를 위한 것인지를 그 요청의 모습 자체로 추론이 가능한 것

 

REST API 디자인 가이드

 

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

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

• 행위(Method)는 URI에 포함하지 않는다.

REST API 설계 규칙

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

• resource는 동사보다 명사를, 대문자 보다 소문자를 사용
• resource의 도큐먼트 이름으로는 단수 명사를 사용해야한다.
• resource의 컬렉션 이름으로는 복수 명사를 사용해야한다.
• resource의 스토어 이름으로는 복수 명사를 사용해야한다.

2. 자원에 대한 행위는 HTTP Method로 표현한다.

• URI에 HTTP Method가 들어가면 안된다.
  ex) GET /members/delete/1 (❌), DELETE /members/1 (✅)
• URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
  ex) GET /members/show/1 (❌), GET /members/1 (✅)
  ex) GET /members/insert/2 (❌), POST /members/2 (✅)
• 경로 부분 중 변하는 부분은 유일한 값으로 대체한다. (즉, id는 하나의 특정 resource를 나타내는 고유값이다.)
  ex) student를 생성하는 route: POST /students
  ex) id=12인 student를 삭제하는 route: DELETE /students/12

3. 슬래시 구분자( / )는 계층 관계를 나타내는데 사용한다.
ex) http://api.test.com/houes/apartments

 

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

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

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

• 불가피하게 긴 URI 경로를 사요하게 된다면 하이픈을 사용해 가독성을 높인다.

4. 언더바( _ )는 URI에 사용하지 않는다.

• 언더바는 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 언더바는 사용하지 않는다.

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

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

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

• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함하지 않는다.
• Accept header를 사용한다
  ex) http://api.test.com/members/soccer/345/photo.jpg (❌)
  ex) GET /members/soccer/345/photo HTTP/1.1 Host: api.test.com Accept: image/jpg  (✅)

7. 리소스 간에는 연관 관계가 있는 경우

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

---

2. REST ful API 란?

REST 원칙을 최대한 잘 지켜서 만든 API 를 RESTful API 라고 함.

 

 RESTful하지 않은 예시 vs RESTful한 예시

비 RESTful 방식	RESTful 방식
GET /getUserList	GET /users
POST /createUser	POST /users
PUT /modifyUser?id=1	PUT /users/1
DELETE /deleteUser?id=1	DELETE /users/1

 REST vs REST API vs RESTful API차이

용어	설명
REST	아키텍처 설계 스타일. 원칙을 정의함
REST API	REST 원칙을 기반으로 만든 API
RESTful API	REST 원칙을 잘 지킨 REST API. REST 스러움의 정도를 나타냄