Rest API

김재현·2022년 12월 2일
1

유닛 진행!

목록 보기
18/18

웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신한다.

  • GET: 웹 페이지나 데이터를 요청한다.
  • POST: 새로운 글이나 데이터를 전송한다.
  • DELETE: 저장된 글이나 데이터를 삭제한다.

클라이언트와 서버가 HTTP 통신을 할 때는 어떤 요청을 보내고 받느냐에 따라 메서드의 사용이 달라진다.
사용에는 규칙이 있다. 어떻게 요청과 응답을 하는 것이 바람직한 방법인지 알아보자!

REST API 디자인

0~3단계로 이루어진 4단계 모델이 있다.
3단계 까지 지키키는 어렵기 때문에 2단계 까지만 적용해도 좋은 API라 볼 수 있고 이런 경우 HTTP API라 불러야 한다. 3단계 까지 무조건적으로 적용해야 하는건 아니다. (2단계를 가장 많이 보게 된다.)

0단계

0단계 에서는 HTTP 프로토콜 사용하기만 해도 된다고 한다. 하지만 이럴경우에는 REST API 라 부를 수 없으며 0단계는 REST API를 작성하기 위한 기본단계이다.

1단계

개별 리소스와의 통신을 준수해야 한다.
웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현한다 처럼
개별 리소스에 맞는 엔드포인트를 사용해야 하고 요청하고 받는 정보를 응답으로 전달 해야 한다 는 것이 1단계의 핵심이다.
엔드포인트 작성시에는 행위에 대한 단어 사용은 지양하고 리소스에 집중해 명사 형태의 단어로 작성 해야 하는것이 바람직하다.
리소스 사용에 대한 성공/실패 여부를 반환해야 한다. 응답을 추가할 수 있다.
ex) 예약에 실패했습니다.

2단계

0단계,1단계와는 달리 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
HTTP 메서드 사용시 3가지 규칙이 있는데

  • GET 메서드의 경우 서버 데이터를 변화 시키지 않는 요청 사용해야한다.
  • POST메서드는 요청마다 새로운 리소스를 생성하고 PUT 메서드는 요청마다 같은 리소스를 반환하는데 매 요청마다 같은 리소스를 반환하는것을 멱등이라 부른다.
  • PUT 메서드와 PATCH 메서드도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정 으로 사용한다.

3단계

HATEOAS(Hypermedia As The Engine Of Application State)
하이퍼미디어 컨트롤을 적용한다. 2단계와 동일하지만 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다. 링크 요소는 응답을 받은 다음 하이퍼미디어 컨트롤을 포함하고 있다.

Open API

정부에서 제공하는 공공데이터가 있다. 쉽게 접근할 수 있도록 Open API의 형태로 공공데이터를 제공하고 있다. 무제한으로 이용할 수는 없고 API마다 정해진 이용 수칙이 있고 이용수칙에 따라 제한사항이 있을 수 있다.

API Key

API를 이용하기 위해 API Key가 필요하다. 서버를 운용하는데 비용이 발생하기 때문에 조건없이 데이터를 제공할 의무는 없다.
로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있는 방식이다.

profile
티스토리로 이사갔습니다. => https://lobsterhyeon.tistory.com/

0개의 댓글