REST API란?

REST API란?

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

REST 성숙도 모델

REST API를 보다 실용적으로 적용하기 위해서 만들어진 모델

0단계 - HTTP 프로토콜 사용(API를 사용하기 위한 기본 단계)

ex) 요청 - 예약 가능한 시간 확인

• POST /appointment HTTP/1.1 [헤더 생략]

1단계 - 리소스 통신 준수(개별 리소스에 맞는 엔드포인트 사용)

ex) 요청 - 예약 가능한 시간 확인 (엔드포인트 : /doctors/허준)

• POST /doctors/허준 HTTP/1.1 [헤더 생략]
• 엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스
  에 집중해 명사 형태의 단어로 작성하는 것이 바람직
• 더불어 요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 한다.

2단계 - CRUD에 맞게 적절한 HTTP 메서드 사용

ex) 요청 - 예약 가능한 시간 확인

• GET doctors/허준/slots?data=2022-08-10 HTTP/1.1 [헤더 생략]
• GET 메서드는 body를 가지고 있지 않기 때문에 query parameter를 사용하여 리소스 전달.
• GET 메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• 대체적으로 2단계까지만 작성해도 잘 작성된 API이다.

HTTP 메서드 규칙 유의!

• POST 메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환한다.이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드 PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 한다.
• PUT 메서드와 PATCH 메서드도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용한다.

3단계 - HATEOAS(Hypertext As The Engine Of Application State) 적용

• 2단계의 요청과 동일
• 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성
• WHY?
  • 좀 더 쉽고 효율적으로 리소스와 기능에 접근할 수 있게하는 요소가 될 수 있기 때문.

참고자료

https://martinfowler.com/articles/richardsonMaturityModel.html