REST API란?
웹 애플리케이션에서는 HTTP 메소드를 이용해 서버와 통신합니다. GET을 통해 웹 페이지나 데이터를 요청하고, POST로 새로운 글이나 데이터를 전송하고, DELETE로 저장된 글이나 데이터를 삭제할 수 있습니다.
규약이 존재합니다!
규칙없이 이루어지는 것이 아닙니다. 제대로 보내고 받을 수 있는 약속이 존재합니다.
웹에서 사용되는 데이터나 자원(Resource)를 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말합니다.
HTTP 프로토콜 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서 API가 역할을 수행합니다.
좋은 REST API 디자인
REST API를 잘 적용하기 위해 4단계 모델이 있습니다.
REST 성숙도 모델 - 0단계
0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 됩니다. 물론 이를 REST API라고 할 수 없으며, 0단계는 좋은 REST API를 작성하기 위한 기본 단계입니다.
단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점입니다.
REST 성숙도 모델 - 1단계
1단계에서는 개별 리소스와의 통신을 준수해야 합니다.
REST API는 웹에서 사용되는 모든 데이터나 자원을 HTTP URI로 표현한다고 이야기했습니다. 그래서 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바입니다.
리소스를 변화시키는지 혹은 어떤 응답이 제공되는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요합니다.
REST 성숙도 모델 - 2단계(잘 작성된 API 인정)
CRUD에 맞게 적절한 HTTP 메소드를 사용하는 것에 중점을 둡니다.
2단계의 핵심은 CRUD에 따른 적합한 메소드를 사용 하는 것입니다.
예를들면 조회(READ)하기 위해서는 GET 메소드를 사용하여 요청을 보내고 필요한 리소스를 전달합니다.
생성(CREATE)하기 위해서는 POST 메소드를 사용하여 요청을 보내는 것이 바람직합니다.
메소드를 사용할 때도 규칙이 있습니다.
-
GET: 서버의 데이터를 변화시키지 않는 요청에 사용해야 합니다.
-
POST: 요청마다 새로운 리소스를 생성하고 PUT은 요청마다 같은 리소스를 반환합니다. 따라서 PUT과 POST는 구분해 사용해야 합니다.
-
PUT, PATCH 사용시 주의: PUT은 교체, PATCH는 수정의 용도로 사용합니다.
REST 성숙도 모델 - 3단계
3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다릅니다.
정리
올바른 엔드포인트로 작성, 적절한 응답 코드와 리소스에 대한 정보 기재, CRUD에 적합한 HTTP 메소드 사용 등을 고려해야 좋은 REST API를 디자인 할 수 있습니다.
OPEN API와 API Key
누구에게나 열려 있는 API입니다. 그렇다고 무제한으로 이용할 수 있는 건 아닙니다. API마다 정해진 이용 수칙이 있고, 그 이용 수칙에 따라 제한사항이 있을 수 있습니다.
API를 이용하기 위해서는 Key가 필요합니다. 서버의 문을 여는 열쇠라고 생각할 수 있습니다.
자원에 접근할 수 있는 권한을 API Key의 형태로 제공하고, 데이터를 요청할 때 API Key를 같이 전달해야만 원하는 응답을 받을 수 있습니다.
Postman
API 테스트 도구입니다. 클라이언트 입장에서 서버 API를 테스트하거나, API를 만드는 과정에서 유용하게 사용됩니다.
HTTP로 소통하기 위해서는 API 서버의 endpoint가 URL로 주어져야 합니다.
