[CS] RESTful API

REST

REpresentational State Tranfer의 약자로 웹의 장점을 최대한 활용할 수 있는 클라이언트와 서버 간의 통신 방식 중 하나.

설계 기본 규칙으로 HTTP URI를 통해 자원을 명시하고 HTTP METHOD를 통해 자원을 처리하도록 설계된 아키텍처이다.

 

RESTful

REST 아키텍처를 구현하는 웹 서비스를 나타내는 것으로 REST 원리를 따르는 시스템을 말한다.

즉, REST 아키텍처의 기본 원칙을 성실히 지킨 서비스 디자인은 'RESTful'하다고 표현할 수 있다.

 

---

REST 구성

- 자원 (Resource) : URI -> 정보의 자원을 표현해야 한다.

- 행위 (Verb) : HTTP METHOD -> 자원의 행위를 표현한다.

- 표현 (Representations)

 

REST 특징

• Uniform (유니폼 인터페이스)
  URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일.
• Stateless (무상태성)
  작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키 정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 되어 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.
• Cacheable (캐시 가능) - 큰 특징 중 하나
  HTTP라는 기존 웹표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 그래서 HTTP가 가진 캐싱 기능이 적용 가능해 HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용해 캐싱을 구현할 수 있다.
• Self-descriptiveness (자체 표현 구조) - 큰 특징 중 하나
  REST API 메시지만 보고도 쉽게 이해 할 수 있는 자체 표현 구조를 이룬다.
• Client - Server 구조
  REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보 등) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성으 줄어든다.
• 계층형 구조
  REST 서버는 다중 계층으로 구성될 수 있다.
  보안, 로드 밸런싱, 암호화 계층을 추가해 구조상 유연성을 둘 수 있다.
  PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

 

REST API

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

- 자원의 행위는 HTTP METHOD로 표현한다.

GET /members/delete/1
// 위는 잘못된 방식 -> URI는 자원의 표현에 중점을 둬야 함으로 delete 같은 행위에 대한 표현 들어가면 안된다.

DELETE /members/1
// 옳은 방식

 

 

---

REST 설계 시 주의할 점

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

- URI 마지막 문자에는 슬래시 불포함.

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

- 밑줄( _ )은 URI에 사용하지 않음.

- URI 경로에는 소문자 사용.

- 파일 확장자는 URI에 불포함. (Accept header 사용)

 

---

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