RESTful API Summary

📘REST의 뜻

• 웹 상에서 두 컴퓨터가 통신하기 위한 일련의 규칙들의 집합
• Representational State Transfer의 줄임말
• server가 리소스를 나타내는 정보(representation of resource),그리고 리소스의 state를 변화시킬 수 있는 링크를 보낸다는 점에서 REST로 불렀다. 다만 대다수의 웹서비스에 적용된 RESTful API들은 링크를 보내지는 않는다.
• REST의 규칙을 준수하는 WEB API를 RESTful API라 부른다.
• 주로 HTTP를 기반으로 하는 Web App에 사용된다.

---

RESTful API가 되기 위한 조건

Uniform Interface

• URI(URL)을 통하여 리소스를 표현한다.
• 리소스 수정/삭제 요청시 충분한 메타데이터가 포함되어야 한다.
• HATEOAS: 서버로부터 제공되는 링크를 통해 클라이언트는 필요한 리소스를 모두 접근할 수 있어야 한다.
• 메시지는 해당 메시지를 어떻게 처리할지에 대한 충분한 설명을 제공해야 한다.

Client-Server Architecture

클라이언트가 UI/UX를 담당하고, 서버가 데이터를 담당한다.

Statelessness

서버는 클라이언트를 위해 요청 사이에 추가적인 정보(상태)를 유지하고 있으면 안 된다.

Cacheability

클라이언트가 보내는 요청에 safe method가 사용이 된다면 서버는reverse proxy를 배치하여 캐싱이 가능하다.

Layered System

클라이언트와 종단 서버 사이의 통신에 프록시, 로드밸런서, 암호화를 위한 중간자 서버가 개입하면 안 된다.

Code on demand(optional)

서버는 상황에 따라 클라이언트에게 executable codes를 보낼 수 있다.

---

Idempotence

• idempotent method는 아무리 여러번 호출되더라도 동일한 결과를 가진다.
• 동일한 결과는 resource representation이 동일하다는 뜻이다.
• GET, PUT, DELETE는 모두 idempotent methods이다.

---

🆕 Versioning RESTful API

가장 대표적인 방법은 version number를 url에 포함시키는 것이다.

---

❌ Accept-Language/Accept Header

HTTP request의 accept-language에 명시된 대로 resource를 보낼 수 없다면, status code 406를 반환해야한다.

---

참고문헌:

https://restcookbook.com

https://en.wikipedia.org/wiki/Representational_state_transfer