API & REST

seyong·2021년 12월 5일
0
post-thumbnail

1) API란 무엇일까?

RESTful api 에 대해 말하기전에 먼저 API 에 대해 말하고 넘어가겠다.

  • API(Application Programming Interface)

api는 비유하자면 키보드와 유사하다고 할 수 있다.

우리는 컴퓨터와 대화하려면 키보드를 통해 입력하여 컴퓨터와 대화한다.
키보드의 버튼을 누르면 ➡ 키보드에서 컴퓨터로 전달되고 ➡ 화면을 통해 텍스트를 볼 수 있다.

키보드를 통해서 컴퓨터와 의사소통, 상호작용(interaction)을 하는 것이다.

이와 같은 맥락으로 API는 프로그램과 프로그램이 서로 상호작용하는 것을 도와주는 매개체이다.

다시 말하자면 인간이 아닌 프로그래밍 코드들끼리 서로 소통하기 위해 만들어진 게 API인 것이다.

2) API 역할

API는 웹,앱과 사용자가 원할하게 통신할 수 있도록 한다.

    1. 사용자가 웹 또는 앱에 접속하여 쇼핑사이트에서 장바구니에 있는 리스트를 보고 싶어 한다. ➡ 장바구니 클릭
    1. 클릭과 동시에 사용자는 서버에 장바구니 리스트를 보여달라고 요청(request)한다.
    1. 서버는 사용자에게 JSON 방식(문자열 방식)으로 응답(response)한다.

➡ 즉, API는 사용자와 웹,앱 간의 데이터를 원할히 주고받을 수 있도록 중간 매개체 역할을 해주는 셈이다.

JSON 방식? 이것은 무엇일까

JSON 이란 JavaScript Object Notation의 줄임말로, 속성 값으로 이루어진 데이터 오브젝트를 전달하기 위해 인간이 읽을 수 있는 텍스트를 사용하는 개방형 표준 포맷이다.

특히, 인터넷에서 자료를 주고 받을 때 그 자료를 표현하는 방법으로 알려져 있다.

JSON은 문자열 형태로 존재하고 이것은 네트워크를 통해 전송할 때 아주 유용하다.

JSON은 JavaScript 객체 문법과 매우 유사하지만 딱히 JavaScript가 아니더라도 JSON을 읽고 쓸 수 있는 기능이 다수의 프로그래밍 환경에서 제공된다.

예를 들어 장바구니에 담겨있는 상품에 대한 정보를 서버에서 응답해주는 객체를 보자면


{
  "product_id" : "1"
  "product_name" : "Oxford shirt"
  "product_option" : "white"
  "product_amount" : "1"
  "product_price" : "59900"

}

이런식으로 보여질수 있다.

3) 다양한 API 종류

API에는 다양한 종류들이 있다.

REST API, GraphQL API, SOAP api 등등...

'웹,앱과 사용자 간이 서로 소통할 수 있게 도와준다' 라는 같은 목적을 가진 생김새만 다른 키보들이다.

공공API(public API)

공공 API 중에는 날씨 API가 있다. 만약 한국 날씨 정보를 원한다면 전 세계 날씨 정보를 갖고 있는 서버에서 한국 날씨 정보를 요청해야 할 것이다. 그러나 네이버가 날씨 데이터를 공개해도 대부분의 사람들은 그 데이터를 가지고 자신에게 맞게 사용하기가 어려울 것이다. 정보가 너무 방대하기 때문이다. 그렇기 때문에 네이버에선 자사 데이터를 활용하여 사용할 수 있게끔 '네이버 날씨API'를 사용자들에게 공개한 것이다.

public API는 개방형 API로, 모두에게 공개된다. 누구나 제한 없이 API를 사용할 수 있는게 특징이다.

누구자 제한없이 API를 사용할 수 있지만 제 3자에게 노출되거나 중요한 기업 데이터가 유출될 수도 있다. 또 API는 데이터, 서버를 갖고있는 사람들이 원하는대로 디자인 할 수 있다. 그래서 어떤 API는 접근권한이 정해져 있다. 가끔은 API 사용에 제약이 있거나 사용하기 위해서 지불해야 할 때도 있다.

Web API는 브라우저를 위해 만든 API를 뜻한다.
구글, 크롬, 파이어폭스, Microsoft Edge 등등 이 있다.
이전엔 API가 매우 작았지만 지금은 많이늘어나서 유저의 마이크 엑세스를 요청하거나 유저의 카메라의 접근권한을 요청하거나 유저의 지역위치 접근권한을 요청하는 등 할수있게 되었다.

REST API

REST API란 REST를 기반으로 만들어진 API를 의미한다.
REST API를 알기 위해 REST부터 알아보도록 하자.

REST란
REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미한다.

즉 REST란

  1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,

  2. HTTP Method(POST, GET, PUT, PATCH, DELETE)를 통해

  3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.

CRUD Operation이란

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로
REST에서의 CRUD Operation 동작 예시는 다음과 같다.

Create : 데이터 생성(POST)
Read : 데이터 조회(GET)
Update : 데이터 수정(PUT, PATCH)
Delete : 데이터 삭제(DELETE)

REST의 구성요소

REST는 다음과 같은 3가지로 구성이 되어있다.

  1. 자원(Resource) : HTTP URI
  • 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
  • 자원을 구별하는 ID는 '/exgroups/:exgroup_id'와 같은 HTTP URI 이다.
  • Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
  1. 자원에 대한 행위(Verb) : HTTP Method
  • HTTP 프로토콜의 Method를 사용한다.
  • HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공한다.(CRUD)

  1. 자원에 대한 행위의 내용 (Representation of Resource) : HTTP Message Pay Load
  • Client와 Server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이\있다.

  • JSON, XML을 통해 데이터를 주고 받는 것이 일반적이다.

REST의 특징

  • Server-Client(서버-클라이언트 구조)

  • Stateless(무상태)

  • Cacheable(캐시 처리 가능)

  • Layered System(계층화)

  • Uniform Interface(인터페이스 일관성)

REST의 장단점

장점

  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.

  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.

  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.

  • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.

  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.

  • 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.

  • 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

  • 표준이 자체가 존재하지 않아 정의가 필요하다.

  • 사용할 수 있는 메소드가 4가지밖에 없다.

  • HTTP Method 형태가 제한적이다.

  • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.

  • 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)


REST API 및 RESTful API 에 관해서는 다음 포스트에서 좀 더 자세히 다루도록 하겠다.

. Reference
https://developer.mozilla.org/ko/docs/Learn/JavaScript/Objects/JSON#%EC%95%84%EB%8B%88_%EB%8C%80%EC%B2%B4_json%EC%9D%B4_%EB%AD%90%EC%A3%A0
https://ko.wikipedia.org/wiki/REST

profile
# 불편함을 편리함으로 바꾸고싶은 주니어 Back-end 개발자

0개의 댓글