API를 활용한 프로젝트를 경험해봤는데, 정작 API가 정확히 무엇인지는 알고 있지 않았다.
그래서, 이번 기회에 정확하게 개념을 정립하려고 한다.
API ?
API가 정확히 뭘 의미하는가?
API는 Application Programming Interface(애플리케이션 프로그램 인터페이스)의 줄임말이다.
API 맥락에서,
Application(애플리케이션)은 고유한 기능을 가진 모든 소프트웨어를 의미한다.Interface(인터페이스)는 두 애플리케이션 간의 서비스 계약이라고 볼 수 있다. 이 계약은Requset(요청)과Response(응답)을 사용하여 두 애플리케이션이 서로 통신하는 방법을 정의한다.
말이 너무 어렵다. 간단하게 바꿔보자.
API는 키보드와 같다. 무슨 말이지?
자, 우리가 컴퓨터와 대화하려면 어떻게 해야할까?
개발을 한다면 코드(텍스트)를 작성해서 프로그램을 만든다.
그러면 이 코드는 어떻게 작성할까?바로, 키보드로 작성한다.
그러니까 우리는 키보드를 통해서 컴퓨터와 대화를 하는 것이다.
✅ 즉, API는 프로그램들이 서로 소통을 할 수 있도록 도와주는 하나의 매개체로 볼 수 있다.
추가 설명 ?
코드들끼리 서로 소통하기 위해 만들어진 것이 API이다.
API는 서버에서 만들어지고, 이 API를 앱에 전달을 한다.앞서 API는 키보드와 같다고 했다.
예를 들어 각각의 키들이 로그인, 로그아웃, 권한 요청, 게시물 업로드, 팔로우 요청 등의 기능을 수행한다고 하자.
우리가 앱에서 이 키들을 누르면 백엔드 데이터베이스, 서버로 가서 어떤 키를 눌렀는지 알려준다. 그 후 키를 누른 결과를 우리에게 보여준다.이렇듯 서로의 소통을 도와주는 역할을 하는 것이 API이다.
API의 역할은?
- 서버와 데이터베이스에 대한 출입구 역할
- 데이터베이스에는 많은 중요한 정보가 저장된다. 그렇기 때문에 모든 사람들이 접근할 수 있다면 문제가 생길 수 있다. 이를 방지하기 위해 API가 서버와 데이터베이스에 대한 출입구 역할을 한다.
- 애플리케이션과 기기의 원활한 통신
- 애플리케이션은 우리가 사용하는 프로그램 또는 어플을 의미한다.(인스타그램, 페이스북, 유튜브 등) API는 이러한 어플과 기기 사이에서 데이터를 원활히 주고받을 수 있게 도와준다.
- 모든 접속의 표준화
- 기계/ 운영체제 등과 상관없이 누구나 동일한 액세스를 얻을 수 있다. 즉, API는 범용 플러그처럼 작동한다고 볼 수 있다.
사용 예시
우리가 인기 급상승 중인 영화 데이터를 알아보고 싶다고 하자.
TMDB API를 사용해보겠다.
https://api.themoviedb.org/3/movie/popular?api_key=${API_KEY}
TMDB API는 인기 영화 요청(request)에 필요한 URL을 다음과 같이 명시하고 있다.
이를 이용해서 데이터를 뽑아내보면 다음과 같다.
{"page":1,
"results":[{"adult":false,
"backdrop_path":"/hiHGRbyTcbZoLsYYkO4QiCLYe34.jpg",
"genre_ids":[27,9648,53],
"id":758323,
"original_language":"en",
"original_title":"The Pope's Exorcist",
"overview":"Father Gabriele Amorth, Chief Exorcist of the Vatican, investigates a young boy's terrifying possession and ends up uncovering a centuries-old conspiracy the Vatican has desperately tried to keep hidden.","
popularity":3591.591,
"poster_path":"/9JBEPLTPSm0d1mbEcLxULjJq9Eh.jpg",
"release_date":"2023-04-05",
"title":"The Pope's Exorcist",
"video":false,
"vote_average":7.4,"vote_count":717},
{"adult":false,"
backdrop_path":"/3CxUndGhUcZdt1Zggjdb2HkLLQX.jpg",
"genre_ids":[28,12,878],
"id":640146,"original_language":"en",
"original_title":"Ant-Man and the Wasp: Quantumania",
"overview":"Super-Hero partners Scott Lang and Hope van Dyne, along with with Hope's parents Janet van Dyne and Hank Pym, and Scott's daughter Cassie Lang, find themselves exploring the Quantum Realm, interacting with strange new creatures and embarking on an adventure that will push them beyond the limits of what they thought possible.",
"popularity":3783,
"poster_path":"/qnqGbB22YJ7dSs4o6M7exTpNxPz.jpg",
"release_date":"2023-02-15",
"title":"Ant-Man and the Wasp: Quantumania",
"video":false,"vote_average":6.6,"vote_count":2346}, ...
}결과를 보면, 이번에 재밌게 본 앤트맨3가 보인다.
각설하고 데이터를 보면 영화의 줄거리, 제목, 몇 세 이상인지, 장르는 무엇인지 등을 알려준다.
만약, 우리가 API 없이 인기 영화 데이터를 갖고 싶다면 일일히 노가다를 해야할지도 모른다. 아찔하다.
요약
- 위 사용 예시에서도 보았듯이, 만약 어떤 데이터들이 필요한데 일일히 뽑아내려면 너무 비효율적이고 상상만해도 아찔할 것이다.
- API를 사용한다면, 이러한 불편함을 덜 수 있고 해당 API가 제공하는 문서를 참고하여 요청만 하면 API 제공자들이 제공하는 데이터들을 가져다 쓸 수 있다.
- 단, API가 모두 무료로 사용가능한 것은 아니며 일부 유료도 있다.
- 또한, 공개된 API가 아니라면 사용할 수 없고 제공하는 문서가 없다면.. 여기까지
[번외] REST
REST란?
REST는 Representational State Transfer 의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.
즉 REST란,
- HTTP URI를 통해 자원(resource)를 명시하고
- HTTP Method(POST, GET, DELETE, PATCH 등)를 통해
- 해당 자원(RUI)에 대한 CRUD Operation을 적용하는 것이다.
CRUD Operation?
CRUD는 Create(C) , Read(R) , Update(U) , Delete(D) 를 묶어서 표현하는 말이다.
- Create : 데이터 생성(POST)
- Read : 데이터 조회(GET)
- Update : 데이터 수정(PUT, PATCH)
- Delete : 데이터 삭제(DELETE)
[참고] HTTP Method
| Method | 역할 |
|---|---|
| GET | 리소스 조회하고 해당 리소스를 가져온다. |
| POST | 요청 데이터 처리, 주로 등록에 사용 |
| PUT | 리소스의 전체 교체, 해당 리소스가 없으면 생성 |
| DELETE | 리소스 삭제 |
| PATCH | 리소스의 일부 교체 |
REST 구성 요소
- 자원(Resource) : URI
- 자원에 대한 행위(Verb) : HTTP Method
- 자원에 대한 행위의 결과(내용, 표현/Representation) : HTTP Message Payload
REST 특징
- Uniform Interface
- URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행
- Stateless
- 상태정보를 따로 저장하고 관리하지 않는다.(HTTP 프로토콜이 Stateless이므로 REST도 동일)
- API 서버는 들어오는 요청만을 단순히 처리하면 된다.(세션, 쿠키 정보를 별도로 저장&관리 ❌)
- Cacheable
- HTTP가 가진 캐싱 기능이 적용 가능 (HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능)
- 캐싱 덕분에 응답 시간이 빨라진다.
- Self-descriptiveness
- 자체 표현 구조를 의미한다.
- REST API 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현 구조로 되어있다.
- Client-Server
- REST 서버는 API 제공
- 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리
- 각각의 역할이 명확하게 구분되어있다.
- Layered System
- REST Server는 다중 계층으로 구성될 수 있다.
- REST Client는 REST API Server만 호출한다.
REST API란?
REST를 기반으로 만들어진 API를 의미한다.
REST API 중심 규칙
가장 중요한 항목은 다음 2가지로 요약 가능하다.
- URI는 정보의 자원을 표현해야 한다.
- 자원에 대한 행위는 HTTP Method(
GET,POST,PUT,DELETE)로 표현한다.
- URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용한다)
GET /members/delete/1- 위의 예시는 행위를 의미하는 delete 표현이 사용되었으므로, REST를 제대로 적용하지 않은 URI이다. → ✅ URI는 자원을 표현하는데 중점을 두어야 한다.
- 자원에 대한 행위는 HTTP Method(
GET,POST,PUT,DELETE등)로 표현한다.DELETE /members/1- 위의 잘못된 URI를 HTTP Method를 통해 수정한 코드이다.
- 슬래시 구분자(
/)는 계층 관계를 나타내는 데 사용한다. - URI 마지막 문자로 슬래시(
/)를 포함하지 않는다.http://restapi.example.com/houses/apartments/ ❌ http://restapi.example.com/houses/apartments ⭕️ - 하이픈(
-)은 URI 가독성을 높이는데 사용 - 밑줄(
_)은 URI에 사용하지 않는다. - URI 경로에는 소문자가 적합하다.
- 파일 확장자는 URI에 포함시키지 않는다.
http://restapi.example.com/members/soccer/345/photo.jpg ❌
[참고]
[참고]
https://aws.amazon.com/ko/what-is/api/
