REST란?
HTTP URI를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.
CRUD Operation이란
CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리
REST에서의 CRUD Operation 동작 예시는 다음과 같다.
- Create : 데이터 생성(POST)
- Read : 데이터 조회(GET)
- Update : 데이터 수정(PUT)
- Delete : 데이터 삭제(DELETE)
REST 구성요소
- 자원(Resource) : HTTP URI
- 자원에 대한 행위(Verb) : HTTP Method
- 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load
REST의 특징
- Server-Client(서버-클라이언트 구조)
- Stateless(무상태)
- Cacheable(캐시 처리 가능)
- Layered System(계층화)
- Uniform Interface(인터페이스 일관성)
REST API
REST API란 REST의 원리를 따르는 API
- REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.
- 웹 애플리케이션에서는 HTTP 메소드를 이용해 서버와 통신을 하는데, 어떤 요청을 보내고 받느냐에 따라 메소드의 사용이 달라지며 그에 따라 제대로 통신이 가능하도록 일종의 규약이 존재한다.
- REST API는 로이 필딩의 박사학위 논문에서 웹(http)의 장점을 최대한 활용할 수 있는 아키텍처로 처음 소개되었다.
REST API 설계 규칙
REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있다.
- URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.
- 마지막에 슬래시 (/)를 포함하지 않는다.
- 언더바 대신 하이폰을 사용한다.
- 파일확장자는 URI에 포함하지 않는다.
- 행위를 포함하지 않는다.
REST API의 좋은 디자인 방법
- 로이 필딩이 논문에서 제시한 REST 방법론을 리차드슨이 4단계(0~3단계)의 모델로 만들어 보다 실용적으로 적용할 수 있도록 했다.
리차드슨의 REST 성숙도 모델
로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했지만 실제로 3단계까지 엄밀하게 지키기 어려워 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우에는 HTTP API라고 부른다.
REST 성숙도 모델 - 0단계
0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 좋은 REST API를 작성하기 위한 기본 단계이다.
REST 성숙도 모델 - 1단계
1단계에서는 개별 리소스와의 통신을 준비해야 한다고 한다. REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현하기 때문에 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바이다.어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다. 엔드포인트 작성 시에는 동사, HTTP 메소드 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.또한 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.
REST 성숙도 모델 - 2단계
2단계에서는 CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둔다. 모든 요청을 CRUD에 상관없이 POST로만 작성한다면 당연히 적합한 메소드 사용이 아니다.조회(READ)를 하는 행위에는 GET 메소드를, 생성(CREATE)하는 행위에는 POST 메소드를 사용하여 요청을 보내는 것이 바람직하다.또 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요하다. 응답이 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야한다.이렇게 해야 REST 성숙도 모델의 2단계를 충족한 것이라 볼 수 있다.메소드를 사용할 때의 규칙이 있다.
- GET : 서버의 데이터를 변화시키지 않는 요청에 사용
- POST : 요청마다 새로운 리소스를 생성
- PUT : 요청마다 같은 리소스를 반환매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메소드 PUT과 그렇지 않은 POST는 구분하여 사용해야 한다.
- PATCH : 수정의 용도로 사용 (PUT은 교체의 용도, PUT과 PATCH도 구분해서 사용해야 한다)
- 참고 : MDN HTTP request methods
REST 성숙도 모델 - 3단계
3단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다.이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.쉽게 말해 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트다.만약 클라이언트 개발자들이 응답에 담겨져 있는 링크들을 눈여겨본다면 이러한 링크들은 조금 더 쉽고 효율적으로 리소스와 기능에 접근할 수 있게 하는 트리거가 될 수 있다.
RESTful이란?
RESTFUL이란 REST의 원리를 따르는 시스템을 의미.
하지만 REST를 사용한다고 RESTful 한 것은 아니다.
REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있다.
예를 들어, 모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 REST API의 설계 규칙을 올바르게 지키지 못한 시스템이라 할 수 있다.
따라서, REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있다.
⚽️마치면서..
유튜브에 생활코딩님의 REST API 동영상 강의 중 실습 영상이 있는데 따라하면서 익히면 더욱 좋을 것 같다.
따라해보고 알게 된 내용은 따로 정리할 것이다.
https://velog.io/@euisuk95/%EC%83%9D%ED%99%9C%EC%BD%94%EB%94%A9-REST-API-%EC%8B%A4%EC%8A%B5-%EB%94%B0%EB%9D%BC%ED%95%B4%EB%B3%B4%EA%B8%B0
