REST API

REST 아키텍쳐 스타일을 따르는 API

REST란?

• REpresentational State Transfer
• 인터넷 상의 시스템 간의 상호 운용성을 제공하는 방법 중 하나
• 시스템 제각각의 독립적인 진화를 보장하기 위한 방법

REST의 요소

• 자원(RESOURCE) - URI
• 행위(VerB) - HTTP METHOD
• 표현(Representations)

REST의 특징

• Uniform Interface(유니폼 인터페이스) Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.
  1. Identification of resources
     • 자원을 명시
  2. Manipulation of resource through representations
     • 표현을 통해 자원을 다룬다.
  3. self-descriptive messages
     • REST API 메시지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조이다.
     • 서버가 전하는 메세지가 변해도 메세지를 보고 해석 가능해야 한다.
     • 확장 가능한 커뮤니케이션
  4. hypermisa as the engine of application state(HATEOAS)
     • 응답에 애플리케이션의 상태 변화가 가능한 하이퍼미디어 정보를 갖고 있어야 한다.
     • 하이퍼미디어를 통해 다른 상태로 전이할 수 있어야 한다.
     • 링크 정보를 동적으로 바꿀 수 있다.

• Stateless(무상태성) REST는 무상태성 성격을 갖는다. 세션 정보나 쿠키 정보를 별도로 저장하지 않기에, API 서버는 들어오는 요청만을 단순히 처리한다. 이를 통해 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않기에 구현이 단순해진다.

• Cacheable(캐시 가능) REST는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능을 적용할 수 있다. HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그 혹은 E-Tag를 이용하면 캐싱 구현이 가능하다.
  • E-Tag란 HTTP 컨텐츠가 바뀌었는지 검사할 수 있는 태그로, 같은 주소의 자원이라도 컨텐츠가 달라졌다면 E-Tag가 다르다.

• Client-Server 구조 REST 서버는 API 제공하고 클라이언트는 사용자 인증이나 컨텍스트 정보등을 직접 관리하는 구조로 각각의 역할이 확실히 구분된다. 이 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

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

REST API 설계

REST API 설계 시 가장 중요한 항목이 2가지 있다.

• URI는 정보의 자원을 표현한다.(리소스명은 복수 명사를 사용한다)
• 자원에 대한 행위는 HTTP METHOD를 통해 표현된다.

1. GET /members/delete/1 
    -> 잘못된 설계(URI는 자원을 표현하는데 중점을 두며 행위의 표현이 포함되면 안된다.)

2. GET /members/1 
    -> 1번 멤버 조회

3. POST /members/2
    -> 멤버 추가

4. DELETE /members/1
    -> 1번 멤버 삭제

• HTTP METHOD

1. POST
   • POST를 통해 URI를 요청하면 리소스를 생성한다.
2. GET
   • GET을 통해 해당 리소스를 조회한다.
3. PUT
   • PUT을 통해 해당 리소스를 수정한다.
4. DELETE
   • DELETE를 통해 해당 리소스를 삭제한다.

다음과 같이 URI로 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 진행하는 것이 REST한 API를 설계하는 규칙이다.

• URI 설계 시 주의할 것.
  1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.
  2. URL 마지막 문자로 슬래시(/)를 포함하지 않는다.
  3. 하이픈(-)은 URI의 가독성을 높이기 위해 사용한다.
  4. 언더바(_)는 URI에 사용하지 않는다.
  5. URI 경로에는 소문자가 적합하다.
  6. 파일 확장자는 URI에 포함하지 않는다.
• idempotent
  • 몇번이고 같은 연산을 반복 해도 같은 값이 나온다.
  • fault-tolerant API를 디자인 하는데에 있어 굉장히 중요한 요소이다.

클라이언트가 POST /requests 를 요청했을때, 타임아웃이 발생했다고 가정하자.
이 때, 클라이언트가 원하는 operation이 idempotent 하다면 항상 같은 결과를 만들기에 같은 요청을 다시 보내도 상관없다.
하지만 POST method는 idempotent 하지 않다.

참고: 스프링 기반 REST API 개발 - REST API