HTTP / NETWORK _ REST API

dltmdal0928·2022년 6월 10일
0

REST API

REST는 “Representational State Transfer”의 약자로 직역하면 “대표 상태 전송” 이라는 뜻이다.

REST API웹에서 사용되는 데이터나 자원(Resource)를 HTTP URI로 표현하고, HTTP 프로토콜을 통해서 요청과 응답을 정의하는 방식을 말한다.

REST API 디자인하는 방법

API는 클라이언트와 서버가 소통하는데 중요한 역할을 하기 때문에 모두가 잘 알아보도록 디자인하는 것이 중요하다. 그렇다면 어떻게 적절한 REST API를 작성할 수 있을까?

REST API를 잘 적용하기 위해서 레오나르도 리차드슨은 4가지의 모델을 만들었다.

REST API 작성 시 모든 단계를 충족하는 것이 가장 좋겠지만 엄밀히 말하면 3단계까지 지키기도 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고 이 경우를 HTTP API라고 한다.

REST 성숙도 모델 - 0단계

RMM에 따르면 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. (물론 이 경우 해당 API를 REST API라고 할 수 없다)

이렇게 단순하게 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다

REST 성숙도 모델 - 1단계

RMM에 따르면 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.

쉽게 말해, REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현하므로, Resource는 개별 리소스에 맞는 각각의 엔드포인트를 사용해야 하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

적절한 엔드포인트 작성법

1단계에서는 상황에 맞게 각기다른 엔드포인트를 사용하기 때문에 적절한 엔드포인트를 작성하는 것이 중요하다.

엔드포인트 작성 시에는 동사, HTTP 메서드 ,어떠 행위에 대한 단어 사용은 지양하고 리소스에 집중해 명사 형태의 단어로 작성하는 것이 중요하다. (EX)/doctor/허준 , slots/123)

응답으로 리소스 전달 시

요청에 대한 응답으로 리소스 전달 시 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/ 실패 여부를 반환해야 한다. (ex) 허준 의사에게 예약 요청했으나 실패함 → 실패 여부 포함한 응답 받아야함)

REST 성숙도 모델 - 2단계

RMM에 따르면 2단계에서는 CRUD (Create, Read, Update, Delete) 에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.

HTTP 메서드 사용 시 규칙

GET 메서드 (READ) : 서버의 데이터를 변화시키지 않는 요청에 사용

POST 메서드 (Create) : POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환(멱등성)하므로, 두 메서드를 구분해서 사용

PUT 메서드 (Update) : PUT 메서드는 교체의 용도, MATCH 메서드는 수정의 용도로 사용하므로, 두 메서드를 구분해서 사용

REST 성숙도 모델 - 3단계

앞서 얘기했다시피, RMM 2단계까지만 충족해도 잘 작성된 API라고 할 수 있기 때문에 RMM 3단계까지 무조건적으로 적용해야 하는 것은 아닌다. (실제로 3단계까지 적용한 REST API도 드물다)

RMM에 따르면 3단계에서는 HATEOAS (Hypertext As The Engine Of Application State) 라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.

3단계의 요청은 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 하는데 이 때 링크 요소에는 응답 받은 다음 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함하고 있다.

Open API 와 API Key

Open API

Open API란, 글자 그대로 누구에게나 열려있는 API를 말한다. (ex) 정부에서 제공하는 공공데이터) 누구에게나 열려있는 API이기는 하지만 API마다 정해진 이용수칙이 있기 때문에 이용수칙에 따라 제한사항이 있을 수 있다.

API Key

API를 이용하기 위해서는 API Key가 필요하다. API Key는 서버의 문을 여는 열쇠이다. (서버를 운용하는데 비용이 필요하기 때문에 서버 입장에서는 아무런 조건 없이 클라이언트에게 데이터 제공할 의무 X)

1개의 댓글

comment-user-thumbnail
2022년 6월 11일

항상 좋은 정보 주셔서 감사합니다!

답글 달기