[JavaScirpt] 자바스크립트 Rest API

참고 사이트 : https://youngjae0412.tistory.com/26

 

REST API

(Representational State Transfer)

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

HTTP 프로토콜 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 하므로 서로 잘 알아볼 수 있도록 작성하는 것이 중요하다.

 

API가 Restful 하다는 것

1. 리소스 중심의 올바른 엔드포인트 작성
2. 적절한 응답 상태 코드
3. 리소스에 대한 정보 기재
4. CRUD에 적합한 HTTP 메소드 사용

 

좋은 REST API를 디자인하는 방법

 

REST API를 작성할 때는 몇 가지 지켜야 할 규칙들이 있다.

로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했지만 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있으며, 이런 경우 HTTP API 라고도 부른다.

 

REST 성숙도 모델 - 0단계

• 단순히 HTTP 프로토콜을 사용하기만 해도 가능하다
• 그러나 REST API라고는 볼 수 없으며 REST API를 작성하기 위한 출발점이다.

요청 내용	요청	응답
예약 가능 시간 확인	POST /appointment HTTP/1.1	HTTP/1.1 200 OK
특정 시간 예약	POST /appointment HTTP/1.1	HTTP/1.1 200 OK

단순 HTTP 프로토콜만 사용하고 요청 내용은 다르지만 같은 요청을 하여 RESTful 하지 않다.

 

REST 성숙도 모델 - 1단계

• 개별 리소스와의 통신을 준수해야 한다
• 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야 한다.
• 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다.
• 리소스에 집중하여 명사 형태로 엔트포인트를 명시해야 한다.
• 응답 리소스 또한 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환하여야 한다.

요청 내용	요청	응답
예약 가능 시간 확인	POST /허준  HTTP/1.1	HTTP/1.1 200 OK
특정 시간 예약	POST/Slots/123/ HTTP/1.1	HTTP/1.1 200 OK or  HTTP/1.1 409 Conflict 요청받은 리소스 + 실패 메세지

예약 가능시간 요청으로 인해 받는 응답은 해당 의사의 예약 가능 시간대이기 때문에 엔드포인트를 허준으로 한 걸 알 수 있으며, 특정 시간에 예약하면 slot이라는 리소스의 123이라는 id를 가진 리소스가 변경되므로, 특정 시간 예약 요청에선 /slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용했다.

 

REST 성숙도 모델 - 2단계

• CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것이 중점이다.
• HTTP 메소드에 맞는 적절한 응답 코드도 중요하다.
• 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인 할 수 있도록 해야한다.

요청 내용	요청	응답
예약 가능 시간 확인	GET /doctors/허준쌤/slots?data=2021-10-10 HTTP/1.1	HTTP/1.1 200 OK {slot[ id 123 ~~]}
특정 시간 예약	POST/Slots/123/ HTTP/1.1	HTTP/1.1 201 Created Location: slots/123/appointment{slot{id~~ patient : 김땡땡}}

시간확인은 조회이므로 GET을 쓰지만 예약은 특정시간에 예약을 만드는 것이므로 POST가 알맞은 메소드이다. POST의 응답 또한 생성을 하므로 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created 로 명확하게 전달해야 한다.

 

HTTP 메소드를 사용할 때 규칙이 있다.

• GET 메소드는 오로지 조회(READ)의 목적이므로, 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• POST는 요청마다 새로운 리소스를 생성한다.
• PUT은 요청마다 같은 리소스를 반환한다. 매 요청마다 같은 리소스를 반환하는 특징을 멱등하다(idempotent)고 한다. 즉, 멱등성을 가지는 PUT 메소드는 POST와 구분하여 사용해야 한다.
• PUT은 교체의 용도로 사용한다.
• PATCH는 수정의 용도로 사용한다.

 

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용을 하면 대체적으로 잘 작성된 API라고 여깁니다. 물론 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한다면 REST API가 아니기 때문에 HTTP API라고 불러야 한다고 주장하지만, 뒤에 만나게 되는 레퍼런스의 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 극히 드뭅니다. 따라서 3단계까지 무조건적으로 모두 적용해야 한다는 것은 아닙니다.

 

REST 성숙도 모델 - 3단계

• HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
• 3단계의 요청은 2단계와 같지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 차이점이다

요청 내용	요청	응답
예약 가능 시간 확인	GET /doctors/허준쌤/slots?data=2021-10-10 HTTP/1.1	HTTP/1.1 200 OK {slot[ id 123 ~~]}, "links" : {~~}
특정 시간 예약	POST/Slots/123/ HTTP/1.1	HTTP/1.1 201 Created Location: slots/123/appointment{slot{id~~ patient : 김땡땡}}, "links" : {~~}, "cancle" : {~~}

허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있습니다. 이렇게 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다.