💡REST API란?
REST API에서 REST는 “Representational State Transfer”의 약자로, REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.
HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하다.
그렇다면 어떻게 해야 적절한 REST API를 디자인할 수 있을까?
💡REST API를 디자인하는 방법
👉 리차드슨의 REST 성숙도 모델을 참고하도록 하자.
REST 성숙도 모델 - 0단계
단순히 HTTP프로토콜을 사용하기만 해도 된다.
물론, 이 경우는 해당 API를 REST API라고는 할 수 없다.
REST 성숙도 모델 - 1단계
1단계에서는 개별 리소스(Resource)와의 통신을 준수해야 한다.
REST API는 웹에서 사용되는 모든 데이터나 자원(Resource)을 HTTP URI로 표현한다고 했다. 따라서 모든 자원은 개별 리소스에 맞는 엔드포인트(Endpoint)를 사용해야하며 요청하고 받는 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계의 핵심이다.
REST 성숙도 모델 - 2단계
CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
🤝 HTTP메서드 사용 규칙!
GET메서드 같은 경우는 서버의 데이터를 변화시키지 않는 요청에 사용POST메서드는 요청마다 새로운 리소스를 생성하고PUT메서드는 요청마다 같은 리소스를 반환, 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 그렇기 때문에 멱등성을 가지는 메서드PUT과 그렇지 않은 메서드POST는 구분하여 사용해야 함.PUT메서드와PATCH메서드도 구분하여 사용!PUT은 교체,PATCH는 수정의 용도로 사용함.
REST 성숙도 모델 - 3단계
HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용, 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 핵심
💡Open API
글자 그대로 누구에게나 열려있는 API입니다. 그러나 "무제한으로 이용할 수 있다"라는 의미는 아니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항(가격, 정보의 제한 등)이 있을 수 있다.
💡API Key
API를 이용하기 위해서는 API Key가 필요한데, API key는 서버의 문을 여는 열쇠이다. 서버를 운용하는 데에 비용이 발생하기 때문에 서버 입장에서 아무런 조건 없이 익명의 클라이언트에게 데이터를 제공할 의무는 없다.
API Key가 필요한 경우에는 로그인한 이용자에게 자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API key를 같이 전달해야 원하는 응답을 받을 수 있다.
출처: codestates
