REST

REST란

REST 구성요소

  1. 자원(Resource): URI
    • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
    • 자원을 구별하는 ID는 '/group/:group_id' 와 같은 HTTP URI 다.
    • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태에 대한 조작을 Server에 요청한다.
  2. 행위(Verb): HTTP Method
    • GET, POST, PUT, DELETE
  3. 표현
    • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
    • JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적이다.

REST 특징

  1. Server - Client
    • Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
    • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
    • 서로 간 의존성이 줄어든다.
  2. Stateless (무상태)
    • HTTP 프로토콜은 Stateless Protocol 이므로 REST 역시 무상태성을 갖는다.
    • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
      • 각 API 서버는 Client의 요청만을 단순 처리한다.
      • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
  3. Cacheable
    • 응답을 캐시할 수 있도록 한다.
  4. Layered System (계층화)
    • Client는 REST API Server만 호출한다.
    • REST Server는 다중 계층으로 구성될 수 있다.
      • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
  5. Code-On-Demand(optional)
  6. Uniform Interface
    • 모든 리소스에 대하여 동일한 인터페이스를 사용한다. 예를 들어, GET은 리소스의 정보를 가져오는데만, POST는 새 리소스를 사용하는데만 사용한다.

REST의 장단점

장점

단점

REST가 필요한 이유


What is REST API?

REST API 설계 규칙

  1. URI는 정보의 자원을 표현해야 한다.
    1. resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
    2. resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
    3. resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
    4. resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
      • ex) GET /Member/1GET /mebers/1
  2. 자원에 대한 행위는 HTTP Method로 표현한다.
    1. URI에 HTTP Method가 들어가면 안된다.
      • ex) GET /members/delete/1DELETE /members/1
    2. URI에 행위에 대한 동사 표현이 들어가면 안된다. (즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
      • ex) GET /members/show/1GET /members
      • ex) GET /members/insert/2POST /members/2
  3. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
  4. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
    • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.