[Network] REST API 알아보기

2021.12.17 - [Computer Science] - [Network] REST 알아보기

[Network] REST 알아보기

REST API란?

REST(Representation State Transfer) 아키텍처의 제약조건을 준수하는 애플리케이션 프로그래밍 인터페이스를 뜻한다.

인터넷과 웹을 통해서 나의 컴퓨터를 제어할 때, 어떻게하면 시행착오를 줄이고 더 좋은 API를 만들 수 있는가에 대한 고민의 결과물이라고 할 수 있다. 이는 기술이 아니라 HTTP를 이용해서 통신을 할 때, HTTP가 가진 잠재력을 최대한 이끌어낼 수 있도록 하는 모범사례로 이해하면 좋을 것 같다.

 

REST API는 아래 세가지의 구성으로 이루어져 있다.

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

REST API의 특징

1. Uniform Interface

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

 

2. Stateless (무상태성)

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

 

3. Cacheable (캐시 가능)

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는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

 GET /members/delete/1 

위와 같은 방식은 제대로 표현하지 않은 URI이다. URI는 자원을 표현하는데 중점을 두어야 한다.

delete와 같은 행위에 대한 표현이 들어가서는 안된다.

 

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

위의 잘못된 URI를 HTTP Method를 통해 아래와 같이 수정할 수 있다.

 DELETE /members/1 

회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 떄는 POST를 사용한다.

 

회원 정보 가져오는 URI

 GET /members/show/1  (x)

 GET /members/1  (o)

회원을 추가하는 URI

 GET /members/insert/2  (x)

 POST /members/2  (o)

 

HTTP METHOD의 알맞은 역할

대표적으로 자주 사용하는 POST, GET, PUT, DELETE 4가지의 Method를 가지고 CRUD를 할 수 있다.

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

위와 같은 방식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙이다.

 

- URI 설계 시 주의할 점

• 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.
• URI 마지막 문자로 슬래시(/)를 포함하지 않는다.
• 하이픈(-)은 URI 가독성을 높이는데 사용한다.
• 밑줄(_)은 URI에 사용하지 않는다.
• URI 경로에는 소문자가 적합하다.
• 파일 확장자는 URI에 포함시키지 않는다.

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

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

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

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

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 '좋아하는' 디바이스 목록을 표현할 경우 아래와 같이 사용할 수 있습니다.

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

 

-자원을 표현하는 Collection과 Document

Document는 단순히 문서로 이해해도 되고, 한 객체라고 이해해도 된다.

Collection은 Document의 집합이다.

이 둘은 모드 리소스라고 할 수 있고 URI에 표현된다.

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

위 URI에서 sports, players는 Collection, soccer, 13은 Document로 표현되고 있다. 

※좀 더 직관적인 REST API를 위해서 컬렉션은 복수, 도큐먼트는 단수 사용.

 

HTTP 응답 상태 코드

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

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

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

상태코드
301	클라이언트가 요청한 리소스에 대한 URI가 변경 되었을 때 사용하는 응답 코드
500	서버에 문제가 있을 경우 사용하는 응답 코드

 

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

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

https://wakestand.tistory.com/463

RESTful API 개념정리