Representational State Transfer
요청과 응답을 할 때, '제대로 보내고 받을 수 있는' 일종의 규약
웹(http) 장점을 최대한 활용할 수 있는 아키텍처로
웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식 을 말한다.
클라이언트와 서버 사이에도 데이터와 리소스를 요청하고, 요청에 따른 응답을 하기 위해 메뉴판이 필요한데, HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴 판이 필요하고 이 역할을 API 가 수행해야 한다.
🏁 Rest API를 디자인하는 방법
REST API를 작성할 때 몇가지 지켜야 할 규칙들이 있는데
이를 위해 REST 성숙도 모델 중 2단계까지만 적용해도 좋은 API디자인 이라고 할 수 있고, 이 경우를 HTTP API 라고 부른다.
📌 Richardson 성숙도 모델 (RMM)
| 단계 | 설명 |
|---|---|
| 0단계 | HTTP 사용 |
| 1단계 | 개별 리소스와의 통신 준수 |
| 2단계 | HTTP 메소드 원칙 준수 |
| 3단계 | HATEOAS 원칙 준수 |
➰ REST 성숙도 모델 - 0단계
0단계에서는 단순히
HTTP 프로토콜을 사용하기만 해도 된다.
⇒ 이 경우, 해당 API를 REST API 라고 할 수 없으며, 작성하기 위한기본 단계이다.
⇒ 단순히 HTTP 프로토콜을 사용하는 것은 REST API의 출발점
🏷 0단계 예시
➰ REST 성숙도 모델 - 1단계
1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.
⇒ REST API 는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현 하는데,
- 모든 자원은
개별 리소스에 맞는 엔드포인트를 사용해야 한다.요청 받는 자원에 대한 정보를 응답으로 전달해야 한다.- 요청에 따른 응답으로 리소스 전달할 때
사용한 리소스에 대한 정보와 리소스 사용에 대한성공/실패 여부를 반환해야 한다.
🏷 1단계에 맞게 바꿔보기
0단계 요청에서 엔드포인트로 /appointment 를 사용했는데, 1단계에서는 요청 리소스가 뭔지에 따라 각각 다른 엔드포인트로 구분해 사용한다.
- 예약 가능 시간 확인이라는 요청의 응답으로 받게되는건 허준 의사의 예약 가능 시간대이니
/doctor/허준이라는 엔드포인트를 사용 - 특정 시간에 예약하면 실제 slots라는 리소스의 123이라는 id를 가진 리소스 변경되니 특정시간에 예약이라는 요청에
/slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용
⇒ 어떤 리소스를 변화시키는지 어떤 응답이 제공되는지 따라 각각 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트 작성하는게 중요하고
리소스에 집중해 명사 형태의 단어로 작성 하는 것이 바람직하다(메서드, 동사 X)
➰ REST 성숙도 모델 - 2단계
CRUD에 맞게 적절한
HTTP 메서드를 사용하는 것에 중점을 둔다.
(0,1단계에서는 CRUD와 관계 없이 POST메서드를 사용함)
🏷 2단계에 맞게 바꿔보기
-
예약 가능한 시간을 확인한다는 것 : 예약 가능 시간을
조회(READ)를 의미
⇒GET메서드 사용해 요청 보내기(GET은 body를 가지지 않기 때문에 query parameter를 사용해 필요한 리소스를 전달한다.) -
특정 시간에 예약한다는 것 : 해당 특정 시간에 예약을
생성(CREATE)의미
⇒POST메서드 사용해 요청 보내기 ⇒ 요청에 대한 응답이 어떻게 반환되는지가 중요하다.
⇒ 응답이 새롭게 생성된 리소스를 보내주기 때문에 응답코드는201 Created
⇒ 관련 리소스를 클라이언트가Location헤더에 작성된 URI를 통해 확인할 수 있도록 해주기
📌 HTTP메서드 규칙
GET메서드 : 서버의 데이터를 변화시키지 않는 요청에 사용POST메서드 : 요청마다 새로운 리소스를 생성한다.PUT메서드 : 요청마다 같은 리소스를 반환한다.
⇒ 매 요청마다 같은 리소스를 반환하는 특징을멱등(idempotent)하다
⇒POST와 잘 구분해서 사용해야 한다.PUT메서드와PATCH메서드도 구분해서 사용해야 한다.
⇒PUT은 교체,PATCH는 수정의 용도로 사용한다.
➰ REST 성숙도 모델 - 3단계
HATEOAS(Hypermedia As The Engine Of Application State) 약어
하이퍼 미디어 컨트롤을 적용합니다.
2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입해 작성합니다.
🏷 3단계에 맞게 바꿔보기
응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는게 핵심 포인트
⇒ 클라이언트 개발자들이 응답에 있는 링크를 눈여겨본다면, 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.
- 허준이라는 의사의 예약 가능 시간을 확인한 후 그 시간대 예약할 수 있는 링크를 삽입하기
- 특정 시간에 예약을 완료하고 나서 그 예약을 다시 확인할 수 있는 링크를 작성해 추가하기
🏁 Open API
정부에서 공공데이터에 쉽게 접근하도록 제공하는 Open API 형태로 제공한다.
⇒ 공공데이터 포털에 접속해 원하는 키워드를 검색하면 확인할 수 있다.
누구에게나 열려있는 API 이지만 무제한으로 이용할 수 있다는 의미는 아니다.
⇒ API마다 정해진 이용 수칙이 있고, 제한사항(가격, 정보의 제한 등)이 있을 수 있다.
🏁 API Key
API 이용하기 위해서는 API Key 가 필요하다.(서버의 문을 여는 열쇠)
서버를 운용하는데 비용이 발생하기 때문에 아무 조건 없이 익명의 클라이언트에게 데이터를 제공할 필요는 없다.(가끔 API Key 필요하지 않은 경우도 있다.)
API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있다.
