[🥝 네트워크] Rest API

[API 관련 글]
https://velog.io/@bommy5799/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-APIAplication-Programing-Interface

---

Rest API

• rest라는 형식의 API로, 서비스제작에서 널리 사용하게 되었다.
  이는 과거의 복잡한 형식인 SOAP을 대체한다.

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

• REST는 HTTP를 잘 활용하기 위한 원칙이라고 할 수 있고 REST API는 이 원칙을 준수해 만든 API이다.
  (❗️ 하지만 실무에서 restAPI를 위한 규칙을 만족하면서 사용하는 것은 거의 불가능에 가까우므로 HTTP API와 rest API는 실제로 거의 동일한 의미로 사용된다고 보면 된다. )

• rest API는 요청을 보내는 주소 자체로도 어떤 요청인지 유추가 가능하다는 특징이 있다.
  자원을 구조와 함께 나타내는 URI라는 구분자를 사용하기 때문이다.

• 웹 애플리케이션 아키텍처에서 클라이언트와 서버가 통신을 할 때 지켜야 할 규약을 프로토콜이라고 하고, 대표적으로 HTTP 프로토콜이 있다.

---

HTTP 요청 메서드

rest API에서는 HTTP에서 요청을 보낼때 사용하는 메서드를 사용한다.

GET- 데이터를 read, 조회하는데 사용
POST - [body], create 새로운 정보를 추가하는데 사용
DELETE - 데이터 삭제시 사용
PUT - [body], 정보를 통째로 갈아끼울때 사용
PATCH - [body], 정보 중 일부를 특정 방식으로 변경할 때 사용

• 각각의 메서드들은 용도가 명확하게 구분되어 있지 않지만, 누구든 요청의 의도를 명확하게 사용하기 위해서는 이들을 목적에 따라 구분해서 사용해야 한다.

• rest의 규칙 중 하나로 URI는 동사가 아닌 명사로 이뤄져야 한다.

• rest는 형식이므로 기술에 구애받지 않는다.

---

REST API를 디자인하는 방법

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

• REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다.
• 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부른다.

(1) REST 성숙도 모델 - 0단계

✅ 단순히 HTTP 프로토콜을 사용하기만 하는 경우

이는 REST API를 작성하기 위한 기본 단계이다.

(2) REST 성숙도 모델 - 1단계

✅ 개별 리소스(Resource)와의 통신을 준수

모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.
요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야한다.

• 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양

• 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직

  

  

(3) REST 성숙도 모델 - 2단계

✅ CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것

REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API로 간주한다.

CRUD는 Create, Read, Update ,Delete를 의미

(1) GET 메서드를 통해 조회 :

예약 가능한 시간에 대해 구체적인 query parameter(slots?date=2022-08-10)를
전달하여 데이터를 확인(Read) 

(2) POST 메서드로 요청, 특정 시간에 예약하기 :

patient를 올바르게 Create하였음을 확인 ("patient":"김코딩") 

(3) POST 요청에 대한 응답 반환 :

명확한 응답 코드(201 Created) 확인,
예약 완료 결과를 Location 헤더에 URI로 반환(Location: slots/123/appointment)
하여 응답을 확인할 수 있음 

(4) REST 성숙도 모델 - 3단계

✅ HATEOAS(Hypermedia As The Engine Of Application State) 하이퍼미디어 컨트롤을 적용 하기.

요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
하이퍼 미디어 컨트롤을 통해 응답에 대해 다양한 액션 요소를 적용할 수 있다.

ex. 예약 가능 시간 확인 후 그 시간대에 예약할 수 있는 링크를 삽입

---