TIL74. HTTP : REST API 란?

📌 이 포스팅에서는 HTTP의 REST API의 개념에 대해 정리하였습니다.

🌈 REST API 란?

🔥 REST API 란?

🔥 REST API 설계 규칙

1. REST API 란?

🤔 RESTful API이 맞을까? REST API가 맞을까?

✔️ ful이란 Statless와 Stateful과 같이 ful이 붙으면 "~한", "~스러운", "~다운" 의미로 해석하면 된다. 이에 RESTful API는 "REST한 API", "REST 다운" 정도로 해석할 수 있다.

✔️ 즉, REST의 원리 또는 REST의 형식을 갖춰 설계된 시스템을 RESTful하다 하고, 이에 REST API를 제공하는 웹 서비스를 RESTful 하다고 할 수 있다.

🤔 그럼 REST 란?

✔️ REST는 "Representational State Transfer"의 약자이다. 근데 RST이지 왜 REST냐 할 수 있지만, 이유는 모른다. Representational에서 RE를 따왔다.

✔️ 그럼 REST란 것이 무엇인가. REST는 HTTP URI를 통해 자원(Resource)을 명시하고, HTTP Method를 통해 자원에 대한 행위를 적용하는 것을 의미한다.

🤔 그래서 REST API 란?

✔️ "사람이 인지하기 쉽게 자원과 상태를 표현한 API"이다. 결국 REST API는 어떤 기술이 아니라 형식이며 API가 REST한 형식을 따랐을 때, REST API라 할 수 있다.

✔️ 이에 REST(Representational State Transfer)은 API는 HTTP 프로토콜을 이용해서 자원의 행위는 HTTP 매서드로 표현하고, URI가 자원을 식별할 수 있게 설계된 형식을 의미한다.

✔️ RESTful API는 그 자체로만으로도 API 목적이 쉽게 이해된다는 장점이 있으나, 표준 규약이 없기 때문에 안티패턴(실제 많이 사용되는 패턴이지만 비효율적이거나 비생적인 패턴)으로 작성되는 경우가 흔하다.

2. REST API 설계 규칙

🤔 URI는 자원을 명확하게 표현해야 한다.

✔️ resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
✔️ resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
✔️ resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
✔️ resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

🤔 자원에 대한 행위는 HTTP Method로 대신한다.

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

GET /members/delete/1 👈 REST API가 아닌 경우
GET /members/1 👈 REST API의 규칙을 따른 경우

✔️ 이에 자원에 행위로써 동사 표현은 불가피한 경우를 제외하고 URL에 들어가면 안된다.

🤔 슬러시, 하이픈, 언더바 규칙

✔️ 슬래시 구분자(/)는 자원의 계층 관계를 나타내는데 사용한다. URI 마지막에는 슬래시(/)를 사용하지 않는다.
✔️ 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
✔️ 밑줄은 보기 어렵기 때문에 가독성을 위해 사용하지 않는다.