REST API

출처 : http://meetup.toast.com/posts/92

- 공부하고자 김동범님의 글을 정리했음을 미리 말씀드립니다.

REST API - Representational State Transfer API

1. 구성

 자원(RESOURCE) - URI

 행위(Verb) - HTTP Method

 표현(Representations)

2. REST의 특징

 1) Uniform (유니폼 인터페이스)

  Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일

 2) Stateless (무상태성)

  REST는 무상태성 성격을 갖는다. 작업을 위한 상태정보를 따로 저장하고 관리하지 않음.

  세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 된다.

  서비스의 자유도는 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순.

 3) Cacheable (캐시 가능)

  REST의 가장 큰 특징 중 하나는 HTTP 라는 기존 웹표준을 그대로 사용.

  웹에서 사용하는 기존 인프라를 그대로 활용이 가능.

  따라서 HTTP가 가진 캐싱 기능이 적용.

  HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능.

 4) Self-descriptiveness (자체 표현 구조)

  REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다.

 5) Client - Server 구조

  REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분.

  클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 된다.

 6) 계층형 구조

  REST 서버는 다중 계층으로 구성될 수 있음.

  보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체 사용 가능.

3. REST API 디자인 가이드

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

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

3-1. REST API 중심 규칙

 1) URI는 정보의 자원을 표현 (리소스명은 동사보다는 명사)

GET /members/delete/1

- REST를 제대로 적용하지 않음. URI는 자원을 표현해야 함. delete와 같은 행위가 들어가면 안된다.

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

DELETE /members/1

- HTTP Method를 통해 수정

회원 정보를 가져올 때는 GET - GET /members/1

회원 추가 시의 행위를 표현하고자 할 때는 POST - POST /members/2

** HTTP Method의 알맞은 역할

POST - 해당 URI를 요청하면 리소스를 생성

GET - 해당 리소스를 조회. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옴

PUT - 해당 리소스를 수정

DELETE - 해당 리소스를 삭제

4-2. URI 설계 시 주의할 점

 

 1) / 는 계층 관계를 나타내는 데 사용

http://restapi.example.com/houses/apartments

http://restapi.example.com/animals/mammals/whales

 2) URI 마지막 문자로 / 를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 한다.

URI가 다르다는 것은 리소스가 다르다는 것. 즉 리소스가 다르면 URI도 달라져야 한다.

REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 / 를 사용하지 않는다.

http://restapi.example.com/houses/apartments/ (X)

 

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

 4) 밑줄(_)은 사용하지 않는다.

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

 6) 파일 확장자는 URI에 포함시키지 않는다.

4-3. 리소스 간의 관계를 표현하는 방법

     

REST 리소스 간에는 연관 관계가 있을 수 있고, 다음과 같은 표현방법으로 사용

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

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

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있다.

ex) GET : /users/{userid}/likes/devices

4.4 자원을 표현하는 Collection과 Document

Document는 단순히 문서로 이해하거나 한 객체로 이해

Collection은 문서들의 집합, 객체들의 집합이라고 생각

-- 두 가지 모두 리소스로 표현할 수 있으며 URI에 표현

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

- sports라는 Collection과 soccer라는 Document로 표현

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

- sports, players : Collection

- soccer, 13 : Document

-- Collection은 복수로 사용하고 있다.

-- 좀 더 직관적인 REST API를 위해서는 단수 복수도 생각하자.

5. HTTP 응답 상태 코드

200 - 클라이언트의 요청을 정상적으로 수행

201 - 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성(POST를 통한 리소스 생성 작업 시)

400 - 클라이언트의 요청이 부적절 할 경우

401 - 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드

( 로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)

403 - 유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드

( 403 보다는 400이나 404를 사용할 것을 권고, 403 자체가 리소스가 존재한다는 뜻)

405 - 클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

301 - 클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용

( 응답 시 Location header에 변경된 URI를 적어 줘야 함)

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

출처 : http://meetup.toast.com/posts/92 - 감사합니다.

필요에 의한 공부를 하는 중입니다. 요즘 하루하루가 의미있고 즐겁습니다.

2018.08.07 - ino