API, REST API, URL, HTTP Method

API

API는 Application Programming Interface의 약자로, 라이브러리에 접근하기 위한 규칙들을 정의한 것을 말한다.

지하철 도착 정보를 알려주는 서비스를 예로 들면, 앞선 서비스는 많은 종류들이 존재한다.

네이버지도, 카카오지도, 구글지도뿐만 아니라 개인이 만든 웹사이트 또는 모바일 앱 등이 존재한다.

많은 종류들의 서비스들이 모두 각각 교통공사에 시간표를 보내달라 요청하는 것일까?

 

교통공사는 서로 다른 서비스들에게 각각 정보를 제공하지 않고, 규칙을 정해 그 규칙에 맞게 정보를 제공해주고 있다.

즉, 규칙에 맞게 정보를 요청한다면 누구나 정보를 얻을 수 있는 것이다.

실제로 서울교통공사에서는 다음 사이트를 통해 규칙을 안내하고 있다.

https://data.seoul.go.kr/dataList/OA-12764/F/1/datasetView.do

 

그리고 처음에 말했듯, 이와 같이 라이브러리(정보)에 접근하기 위한 규칙들을 정의한 것을 API라고 한다.

 

REST API

이제 API를 알았으니 누구나 쉽게 정보에 접근하여 활용을 할 수가 있게 되었다.

그런데 만약 서비스마다 서로 다른 형식의 API를 제공한다면 개발자 입장에서는 서비스마다 API 형식을 맞추기 위해 많은 노력을 쏟아부어야 할 것이다.

 

이에 서버와 클라이언트 사이에서 어떻게 메시지를 교환할지를 정해놓은 규칙인 HTTP에서 더 나아가,

웹 개발자들은 HTTP 규약을 잘 따라 형식을 정하고 지켜 API를 사용하게 된다.

그리고 이 규칙을 REST 아키텍처라 하여, REST 아키텍처를 지킨 API를 REST API라 한다.

 

URL

URL은 Uniform Resource Loader의 약자로 인터넷 상에서 웹페이지가 어디있는지 위치를 알려주는 것뿐만 아니라,

데이터 연산을 해달라 서버에 요청을 보내는 방법이다.

예를 들어 쇼핑몰에서 사용되는 URL을 살펴보자.

 

https://www.coupang.com/

위는 쿠팡 쇼핑몰의 링크이다. 위 링크를 주소창에 입력하면 쿠팡 메인페이지로 이동하게 된다.

https://www.coupang.com/np/search?component=&q=라면&channel=user

위는 쿠팡 쇼핑몰에 "라면"을 검색했을 때의 링크이다.

https://www.coupang.com/np/search?component=&q=즉석밥&channel=user

위는 쿠팡 쇼핑몰에 "즉석밥"을 검색했을 때의 링크이다.

 

라면과 즉석밥 링크의 차이는 &q= 다음 부분의 "라면"과 "즉석밥" 뿐이다.

위 두 개의 URL에서 달라지는 것은 검색어뿐이고 다른 모든 부분은 검색 결과를 요청하는 방법이다.

 

그런데 REST API URL은 아무렇게나 설정할 수 있는 것이 아니라, 규칙들이 존재한다.

• 소문자만 가능, 대문자는 불가능
• - (하이픈) 가능, _ (언더바) 불가능
• 마지막에 / (슬래시) 포함 안됨
• 행위를 포함해서는 안됨
• 파일 확장자를 포함해서는 안됨
• 복수형을 사용

HTTP Method

올바른 API와 URL을 사용하기 위해, HTTP에는 다음과 같은 method들이 있다.

• POST: 생성(등록)
• GET: 조회
• PUT / PETCH: 수정
• DELETE: 삭제

용도에 맞게 알맞은 method를 선택해서 사용하면 된다.