Unit 8] REST API

SEB_FE_45

Section 2. Unit 8. REST API

---

REST API 에대해 블로깅을 하라고 하는데, 이해의 영역이 아닌건가 아니면 뇌가 받아들이질 못하는건가..?

---

REST API 란??

우선, 강의 교안인 URCLASS에서는 REST API를 아래와 같이 정의하였다.

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

다음은 챗 GPT에게 REST API에 대해 정의를 물어본 내용이다.

REST API는 Representational State Transfer API의 약어로, 웹 애플리케이션 간에 데이터를 주고받기 위한 표준화된 방법입니다.
이 방법은 HTTP를 기반으로 하며, 자원 식별, HTTP 메소드, 상태 없음, 표현의 원칙을 따르는 아키텍처 스타일입니다.
REST API를 사용하면 클라이언트와 서버 간의 효율적인 통신과 데이터 교환을 할 수 있습니다.

뭐가 됐든 둘다 이해하긴 어려운 것 같다.

---

리차드슨의 REST 성숙도 모델(REST API 디자인)

로이필딩은 4가지 단계를 모두 지켜야 REST API라고 하지만, 2단계까지만 지켜도 좋은 REST API라고 한다.

 

0단계 - HTTP 사용

단순히 HTTP 프로토콜만 사용하는 단계이다. REST API라고 할 수는 없으며, REST API를 작성하기 위한 기본 단계이다.

 

1단계 - 개별 리소스와의 통신 준수

모든 자원은 개별 리소스에 맞는 적절한 엔드포인트(End point)를 사용해야 한다.

요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.

리소스에 적합한 명사 형태의 엔드포인트를 이용해 데이터를 요청하며, 응답 시에는 성공/실패 여부를 반환해야 한다.

 

2단계- HTTP 메서드 원칙 준수

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

1. 생성(CREATE) = POST 메서드 사용
  - 요청에 대한 응답이 어떻게 반환되는지에 대해 응답코드를 이용하여 클라이언트에게 결과를 전송한다.
  - 요청마다 새로운 리소스를 생성한다.

2. 조회(READ) = GET 메서드 사용
  - body를 가지지 않기 때문에 query pararmeter를 사용하여 필요한 리소스를 전달한다.
  - 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.

3. 갱신(UPDATE) = PUT(or PATCH)
  - PUT 메서드는 요청마다 같은 리소스를 반환한다. 멱등(idempotent)하다고 한다(POST와 구분하자).
  - PUT 메서드는 교체, PATCH 메서드는 수정용도로 사용한다.

4. 삭제(DELETE) = ?

성숙도 모델 2단계까지 적용하면 대체로 잘 작성된 API이다.

 

3단계 - HATEOAS(Hypermedia As The Engine Of Application State, 하이퍼 미디어 컨트롤 적용)

리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다.

링크 요소는 응답을 받은 다음 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함한다.

링크 요소는 리소스와 기능에 조금 더 쉽고, 효율적으로 접근할 수 있게 한다.

---

Open API 와 API Key

Open API는 누구에게나 열려있는 API이다. 단, 무제한으로 이용가능하다는 뜻은 아니다.

정부에서는 공공데이터 포털(https://www.data.go.kr/)에서 공공데이터에 대한 API를 제공한다.

API Key는 서버의 문을 여는 열쇠이다. 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야 원하는 응답을 받을 수 있다.

---

회고..

음.. 나만의 언어로 블로깅을 해보라고 하는데... 솔직히 이해가 되지 않아 나만의 언어로 작성하는데는 한계가 있다.

우선, 이런게 있다는 것만 알고 관련 레퍼런스를 찾아보며 추가로 공부를 해보도록 하겠다.