TIL-45. REST API

REST API란?

Restful API라고도 부르는 REST API는
Representational State Transfer라는 용어의 약자로
자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.

REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 사용하기 때문에
웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.

REST 구성을 살펴보자.

REST API는 다음 3가지 구성으로 이루어져 있다.

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

REST의 특징을 살펴보자.

1. Uniform(유니폼 인터페이스)
   유니폼 인터페이스는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말한다.

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

3. Cacheable(캐시 가능)
   REST의 가장 큰 특징 중 하나는 HTTP 웹 표준을 그대로 사용하기 때문에
   웹에서 사용하는 인프라를 그대로 활용 가능하다는 것이다.
   HTTP에 있는 캐싱 기능 역시 활용 가능하다.

4. 자체 표현 구조
   REST API의 메시지만 보고도 쉽게 이해할 수 있는 자체 표현 구조로 이루어져 있다는 것 또한 큰 특징이다.

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

6. 계층형 구조
   REST 서버는 다중 계층으로 구성될 수 있으며, 보안, 로드 밸런싱, 암호화 계층을 추가해서 구조상의 유연성을 둘 수 있다.
   또 프록시나 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

REST API의 디자인 가이드

REST API 설계 시 가장 중요한 두 가지는 아래와 같다.

1. URI는 정보의 자원을 표현해야 한다. - 리소스명은 동사보다는 명사로!
2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현해야 한다.

GET /members/delete/1 (X)
DELETE /members/1 (O)

delete라는 행위 말고 자원을 표현하는 데 중점을 두어야 한다.

GET /members/show/1 (X)
GET /members/1 (O)

회원 정보를 가져와 보여준다고 굳이 show를 넣을 필요가 없다.

GET /members/insert/2 (X)
POST /members/2 (O)

GET 메서드는 insert와 맞지 않다.
정보를 보내거나 넣는 생성 행위를 할 땐 POST를 사용한다.

URI 설계 시 주의사항

• 슬래시 구분자는 계층 관계를 나타낼 때만 사용한다.
• URI 마지막 문자로 슬래시를 쓰지 않는다.
• 하이픈은 가독성을 높이는 데 사용한다.
• 언더바는 사용하지 않는다.
• URI 경로에는 소문자가 적합하다.
• 파일 확장자는 포함하지 않는다.

리소스 간의 관계를 표현할 때

리소스명/리소스 아이디/관계 있는 다른 리소스명
GET /users/{usersid}/devices - 일반적인 소유의 관계 표현
GET /users/{usersid}/likes/devies - 좀더 구체적인 표현

Collection과 Document

Collection은 문서의 집합, 객체의 집합 정도로 보면 되고
Documen는 문서나 객체 정도로 보면 된다.

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

sports와 players는 Collection,
soccer와 7은 Document이다.
이름을 보면 직관적으로 알 수 있다.
Collectio은 무엇인가의 집합이기 때문에 복수로 사용되고 있다.

HTTP 응답코드

잘 설계된 REST API는 URI뿐 아니라 그 리소스에 대한 제대로 된 응답까지를 의미한다.
아래 자주 쓰이는 코드를 익혀두고 적절하게 사용하자.