RESTful API

월드 와이드 웹(World Wide Web a.k.a WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식으로 자원을 정의하고 자원에 대한 주소를 지정하는 방법 전반에 대한 패턴

REST란 REpresentational State Transfer의 약자이다. 여기에 ~ful이라는 형용사형 어미를 붙여 ~한 API라는 표현으로 사용된다. 즉, REST의 기본 원칙을 성실히 지킨 서비스 디자인은 RESTful하다라고 표현할 수 있다.

REST가 디자인 패턴이다. 아키텍처마다 많은 이야기가 존재하는데, 하나의 아키텍처로 볼 수 있다. 좀 더 정확한 표현으로 말하자면, REST는 Resource Oriented Architecture이다. API 설계의 중심에 자원(Resource)이 있고, HTTP Method를 통해 자원을 처리하도록 설계하는 것이다.

REST 구성

REST API는 다음의 구성으로 이루어져 있다.

  • 자원(Resource) - URI
  • 행위(Verb) - HTTP Method
  • 표현(Representations)

REST 6가지 원칙

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

RESTful 하게 API를 디자인 한다는 것은 무엇을 의마하는가

  1. 리소스와 행위를 명시적이고 직관적으로 분리한다.

리소스는 URI로 표현되는데 리소스가 가리키는 것은 명사로 표현되어야 한다.
행위는 HTTP Method로 표현하고, GET(조회),POST(생성),PUT(기존 entity 전체 수정),PATCH(기존),DELETE(삭제)` 을 분명한 목적으로 사용한다.

  1. Message는 Header와 Body를 명확하게 분리해서 사용한다.

Entity에 대한 내용은 body에 담는다.
애플리케이션 서버가 행동할 판단의 근거가 되는 컨트롤 정보인 API 버전 정보, 응답받고자 하는 MIME 타입 등은 header에 담는다.
header와 body는 http header와 http body로 나눌 수도 있고, http body에 들어가는 json 구조로 분리할 수도 있다.

  1. API 버전을 관리한다.

환경을 항상 변하기 때문에 API의 signature가 변경될 수도 있음에 유의하자.
특정 API를 변경할 때는 반드시 하위호환성을 보장해야 한다.

  1. 서버와 클라이언트가 같은 방식을 사용해서 요청하도록 한다.

브라우저는 form-data 형식의 submit으로 보내고 서버에서는 json 형태로 보내는 식의 분리보다는 json으로 보내든, 둘 다 form-data 형식으로 보내든 하나로 통일한다.
다른 말로 표현하자면 URI가 플랫폼 중립적이어야 한다.

장점

  • Open API를 제공하기 쉽다.
  • 멀티플랫폼 지원 및 연동이 용이하다.
  • 원하는 타입으로 데이터를 주고 받을 수 있다.
  • 기존 웹 인프라(HTTP)를 그대로 사용할 수 있다.

단점

  • 사용할 수 있는 메소드가 4가지 밖에 없다.
  • 분산환경에는 부적합하다.
  • HTTP 통신 모델에 대해서만 지원한다.

REST API 디자인 가이드

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

REST API 중심 규칙

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

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 하므로 delete와 같은 행위에 대한 표현이 들어가서는 안된다.

  1. 자원에 대한 행위는 HTTP Method로 표현
    위의 잘못 된 URI를 HTTP Method를 통해 수정하면

DELETE /members/1

으로 수정할 수 있다. 회원 정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST Method를 사용하여 표현하면 된다.

  • HTTP Method의 역할
  1. POST : POST를 통해 해당 URI를 요청하면 리소스를 생성
  2. GET : GET을 통해 해당 리소스를 조회. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져온다.
  3. PUT : PUT을 통해 해당 리소스를 수정
  4. DELETE : DELETE를 통해 리소스를 삭제

URI 설계 시 주의할 점

  1. 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
  2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
    URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고 역으로 리소스가 다르면 URI도 달라져야 한다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
  3. 하이픈(-)은 URI 가독성을 높이는 데 사용
    URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있다.
  4. 언더바는 URI에 사용하지 않는다.
    글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 한다. 이런 문제를 피하기 위해 언더바 대신 하이픈(-)을 사용하는 것이 좋다.(가독성)
  5. URI 경로에는 소문자가 적합
    URI 경로에 대문자 사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문이다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정함
  6. 파일 확장자는 URI에 포함시키지 않는다.
    REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. Accept header를 사용하도록 한다.

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

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같이 표현

/리소스명/리소스 ID/관계가 있는 다른 리소스명

GET : /users/{userid}/devices (일반적으로 소유 'has’의 관계를 포현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같이 표현 가능

GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적으로 표현이 필요할 때)

자원을 표현하는 Collection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워진다. Document는 단순히 문서로 이해해도 되고, 한 객체라고 이해하면 편하다. Collection은 문서들의 집합, 객체들의 집합이라고 생각하면 이해가 편하다. Collection과 Document는 모두 리소스라고 표현할 수 있으며 URI에 표현된다.

http:// restapi.example.com/sports/soccer

sports라는 컬렉션과 soccer이라는 도큐먼트로 표현된다.

http:// restapi.example.com/sports/soccer/players/13

sports, players 컬렉션과 soccer,13을 의미하는 도큐먼트로 URI가 이루어지게 된다. 여기서 중요한 점은 컬렉션은 복수로 사용한다는 점이다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수, 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있다.

HTTP 응답 상태 코드

  • 200 : client의 요청을 정상적으로 수행함

  • 201 : client가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

  • 400 : client의 요청이 부적절 할 경우 사용하는 응답 코드

  • 401 : client가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
    (로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)

  • 403 : 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 client가 요청했을 때 사용하는 응답 코드
    (403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)

  • 405 : client가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

  • 301 : client가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
    (응답 시 Location header에 변경된 URI를 적어줘야 한다.)

  • 500 : 서버에 문제가 있을 경우 사용하는 응답 코드