[코드스테이츠]-REST API

- REST API란 무엇일까?

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

• HTTP프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요하다.
  여기서 말하는 메뉴판이 -> API

- HTTP API를 디자인하는 방법

CRUD
조회(Read) - GET(body x)
추가(Create) - POST(body 0)
갱신(Update)- PUT또는 PATCH(body o)
- PUT, PATCH의 차이 : put은 해당 자원을 완전히 바꾸는 반면 patch는 일부분만 바꾼다.
삭제(Delete) - DELETE(body x)

- REST API를 디자인하는 방법

- REST 성숙도 모델 : 0단계

• 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도된다. 물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계입니다.

- REST 성숙도 모델 : 1단계

• 1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.
• 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다
  (엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.)

- REST 성숙도 모델 : 2단계

• 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.

  HTTP메소드를 사용할 때의 규칙
  -GET 메소드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
  -POST 메소드는 요청마다 새로운 리소스를 생성하고 PUT 메소드는 요청마다 같은 리소스를 반환한다.
  -PUT 메소드와 PATCH 메소드도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용해야 한다.

• 조회(READ)하기 위해서는 GET 메서드를 사용하여 요청을 보내고, 이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달해야 한다.
  

- REST 성숙도 모델 : 3단계

• 3단계에서는 HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
• 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.

- Open API

• 공공데이터에 쉽게 접근할 수 있도록 정부는 Open API의 형태로 공공데이터를 제공하고 있다.
  ➡️ https://www.data.go.kr/
• Open API는 누구에게나 열려있지만 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.

- API Key

• API를 이용하기 위해서는 API Key가 필요하다.
• API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있다.

- Status Code 종류

• 사진출처 : 코드스테이츠