📖REST API란?
REST는 “Representational State Transfer”의 약자로, 내맘대로 해석하자면 상태를 구체화해 송신한다 정도로 받아들이고 있다.
정확한 의미의 REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.
REST API을 사용해야하는 이유는 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하기 때문이다.
📖REST 성숙도 모델
REST API를 작성할 때는 몇 가지 지켜야 할 규칙들이 있는데, 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.
로이 필딩은 모든 단계를 충족해야만 REST API이라고 주장했지만 실제로는 2단계까지만 정용해도 좋은 API디자인이다. 이 경우는 HTTP API 라고도 부른다.
🏷️0단계 - HTTP사용
HTTP 프로토콜 사용하기
🏷️1단계 - 개별 리소스와의 통신 준수
웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다. 1단계에서는 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다.
어떤 리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다.
엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.
🏷️2단계 - HTTP메서드 원칙 준수
CRUD(Create, Read, Update, Delete)에 맞게 적절한 HTTP 메서드를 사용하기
HTTP 메서드 규칙
GET메서드는 서버의 데이터를 변화시키지 않는 요청에 사용하기.- 새로운 리소스 생성할 때
POST와PUT구분해서 사용해야함.
POST메서드는 요청마다 새로운 리소스를 생성한다. 반면,PUT메서드는 요청마다 같은 리소스를 반환한다. 다시말해 요청을 여러번 한다고 계속해서 새로운 리소스 생성하는게 아니라 한번 보낸 것과 효과가 같다.(멱등성을 가짐) PUT메서드와PATCH메서드 구분하여 사용하기.
PUT은 교체,PATCH는 수정의 용도로 사용한다.
멱등성(idempotent)
동일한 요청을 한 번 보내는 것과 여러 번 연속으로 보내는 것이 같은 효과를 지니고, 서버의 상태도 동일하게 남을 때, 해당 HTTP 메서드가 멱등성을 가졌다고 말합니다.
올바르게 구현한 경우 GET, HEAD, PUT, DELETE 메서드는 멱등성을 가지며, POST 메서드는 그렇지 않습니다.
-MDN 멱등성
🏷️3단계 - HATEOAS 원칙 준수
HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.
3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다. 이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함한다.
📖Open API와 API Key
🏷️Open API란?
누구에게나 열려있는 API이다.
그러나 "무제한으로 이용할 수 있다"라는 의미는 아니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.
🏷️API Key란
API key는 서버의 문을 여는 열쇠이다. API를 이용하기 위해서는 API Key가 필요하다.
서버를 운영하는데는 비용이 발생하기 때문에 아무런 조건없이 익명의 클라이언트에게 데이터를 제공할 의무는 없다. 로그인한 이용자만 자원에 접근할 수 있는 권한 주기위해서 API Key를 사용할 수 있다. 이용자가 데이터를 요청할 때 API Key를 같이 전달해야만 응답을 받을 수 있기때문이다.
마치며..
REST AIP란 API를 모든 사람들이 보기 쉽게 작성하기위한 규칙이다. 3단계까지는 안 해도 2단계까지는 해야함.
0단계는 HPPT 사용하기, 1단계는 리소스 URI로 표현하기, 2단계 CRUD 상황에 맞는 메소드 사용하기, 3단계 응답시 응답 다음으로 할수 있는 상황 하이퍼미디어 컨트롤 포함하기
Open API란 모두에게 공개된 API이다. 그러나 이용 규칙이 있을 수는 있음.
생각보다 유어클래스 진도까지 보는데 오래 걸리 않았다. 그럴수록 내일 할 과제가 걱정되는건 왜일까..ㅋㅋㅋ 미래 좀 읽어봐야겠다
