[programming] REST, REST API, RESTfull

REST

정의

• REST(Representaional State transfer)는 우러드 와이드 웹과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식이다.

구성

• 자원(RESOURCE) - URL

• 행위(Verb) - HTTP METHOD

• 표현(Representations)

특징

유니폼 인터페이스(Uniform)

• URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 아키텍처 스타일을 말한다.

무상태성(Stateless)

• REST는 무상태성 성격을 갖는데 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보다 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 되기 때문에 서비스의 자유도가 높아지고 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

캐시 가능(Cacheable)

• HTTP라는 기존 웹 표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용이 가능하다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하고, HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하여 캐싱 구현이 가능하다.

자체 표현 구주(Self-descriptiveness)

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

Client-Server 구조

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

계층형 구조_

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

REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 (1) URI는 정보의 자원을 표시해야 하고 (2) 자원에 대한 행위는 HTTP METHOD (GET, POST, PUT, DELETE)로 표현해야 한다.

정의

REST API 중심 규칙

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

GET /members/delete/1
// 위 표현 방식은 REST를 제대로 적용하지 않은 URI이다. delete와 같은 행위에 대한 표현이 들어가서는 안된다.

• 자원에 대한 행위는 HTTP Method로 표현

DELETE /members/1
// DELETE로 수정을 해 알맞은 REST API로 수정한다.

• 회원정보를 가지고 올 때

GET /members/show/1 (x)
GET /members/1 (o)

• 회원정보를 추가할 때

GET /members/insert/2 (x)
POST /members/2 (o)

REST URI 설계시 주의 할 점

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

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

• 슬래시 구분자(/)는 마지막 문자로 포함하지 않는다

    http://restapi.example.com/houses/apartments/ (x)
    http://restapi.example.com/animals/mammals/whales (O)
    // URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는
    //것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다. REST API는 
    //분영한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI경로의 마지막에는 슬래시를 사용하지 않는다.

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

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI 경로를 사용하게 된다면 하이픈을 사용하여 가독성을 높일 수 있다.

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

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 한다. 이런 문제를 피하기 위해 밑줄 대신 하이픈을 사용하든 것이 좋다

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

URI 경로에 대문자 사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식되기 때문에 REC 3986은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이다.

• 파일 확장자는 URI에 포함하지 않는다.

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

• 파일 확장자는 URI에 포함하지 않는다.

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

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

/리소스명/리소스 ID/관계가 있는 다른 리소스명
ex)    GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

//관계명이 복잡할 때 (사용자가 좋아하는 디바이스 목록을 표현)
GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

자원을 표현하는 Colllection / Document

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

 http:// restapi.example.com/sports/soccer 
 // soccer 이라는 document로 표현
 
 http:// restapi.example.com/sports/soccer/players/13
 // sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 된다.
 // 

HTTP 응답 상태 코드

상태코드	원인 이유
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨
400	클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
---	(로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403	유저 인증상태와 관계없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
---	403보다는 400이나 404를 사용할 것을 권고, 403 자체가 리소스가 존재한다는 뜻이기 때문
405	클라이언트가 요청한 리소스에는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
500	서버에 문제가 있을 경우 사용하는 응답 코드