REST API란?

https://meetup.toast.com/posts/92

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

 

REST, Representational State Transfer의 약자로서 2000년도에 Roy Fielding의 박사학위 논문에서 최초로 소개되었다. Roy Fieilding은 HTTP의 주요 저자 중 한 사람으로 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다.

 

REST 구성

• Resource(자원) : URI
• Verb(행위) : HTTP METHOD
• Representations(표현)

 

REST 특징

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

 

REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 다음의 두 가지로 요약할 수 있다.

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

REST API 중심 규칙

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

GET /members/delete/1

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

 

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

DELETE /members/1

 

HTTP Method의 알맞은 역할

POST, GET, PUT, DELETE로 CRUD를 할 수 있다.

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

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

 

URI 설계 시 주의할 점

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

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

• URI 마지막 문자로 슬래시 구분자(/)를 포함하지 않음

http://restapi.example.com/houses/apartments (o)
http://restapi.example.com/houses/apartments/ (x)

• 하이픈(-)은 URI 가독성을 높이는데 사용
• 밑줄(_)은 URI에 사용하지 않음
• URI 경로에는 소문자가 적합
• 파일 확장자는 URI에 포함시키지 않음
• REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다. Accept header를 사용

GET / members/soccer/456/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

 

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

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

/리소스명/리소스ID/관계가 있는 다른 리소스명
ex) GET : /users/{userid}/devices

 

 

HTTP 응답 상태 코드

잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 한다. 정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이 될 수도 있다.

 

상태코드	설명
200	클라이언트의 요청을 정상적으로 수행함
201	클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성됨(POST를 통한 리소스 생성 작업 시)

 

상태코드	설명
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
	(응답 시 Location header에 변경된 URI를 적어 줘야 합니다.)
500	서버에 문제가 있을 경우 사용하는 응답 코드

 

상태코드	설명
400	클라이언트의 요청이 부적절 할 경우 사용하는 응답 코드
401	클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때 사용하는 응답 코드
	(로그인 하지 않은 유저가 로그인 했을 때, 요청 가능한 리소스를 요청했을 때)
403	유저 인증상태와 관계 없이 응답하고 싶지 않은 리소스를 클라이언트가 요청했을 때 사용하는 응답 코드
	(403 보다는 400이나 404를 사용할 것을 권고. 403 자체가 리소스가 존재한다는 뜻이기 때문에)
405	클라이언트가 요청한 리소스에서는 사용 불가능한 Method를 이용했을 경우 사용하는 응답 코드

 

 

좀 더 자세한 정보가 필요하다면 아래 블로그를 참고해보자.

https://spoqa.github.io/2012/02/27/rest-introduction.html

REST 아키텍처를 훌륭하게 적용하기 위한 몇 가지 디자인 팁

https://sanghaklee.tistory.com/57

RESTful API 설계 가이드

 

https://ko.wikipedia.org/wiki/REST