Rest Api

Http 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기위해 알아보기 쉽고 잘 작성된 메뉴판이 필요!

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

0단계 : HTTP 사용

-단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점, REST API를 작성하기 위한 기본단계

--------------------------------------------------------------------------------------------------------------

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

모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 ,

요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심

엔드포인트 작성 시에 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직

요청에 따른 응답으로 리소스를 전달할 때에도 사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야 합니다

---------------------------------------------------------------------------------------------------------------

2단계 : HTTP 메소드 원칙 준수

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

예약을 조회(READ). - GET메서드

특정시간에 예약(CREATE) - POST메서드

HTTP 메서드를 사용할 때 몇가지 규칙

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

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 합니다.

----------------------------------------------------------------------------------------------------------------

3단계 : HATEOAS 원칙 준수

응답에 리소스의 URI를 포함한 링크가 포함되어야 한다.

-----------------------------------------------------------------------------------------------------------------

누구에게나 열려있는 API이다. 그러나 "무제한으로 이용할 수 있다"라는 의미가 아니고 API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.

API key는 서버의 문을 여는 열쇠이다.

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

포도 코딩