API에 관한 모든 것

정유빈·2024년 11월 10일

CS 내용 정리

목록 보기
2/2

해당 내용은 수업에서 설명한 부분이 아닌 수업 이외의 내용을 작성한 부분입니다.
API에 대해서 자주 언급되지만 볼때마다 헷갈린 나를 위해 작성하는 페이지

API란?

: 스마트폰으로 카카오톡에 로그인하려는 상황을 떠올려보자
스마트폰이 보낸 로그인 요청은 카카오 본사의 서버 컴퓨터 중 하나가 받은 다음, 알맞은 응답을 다시 스마트폰에 돌려주게 된다. (로그인 처리시키기 or '로그인 성공' 메시지 띄우기)

이것이 클라이언트 - 서버 구조 이다.
클라이언트는 로그인뿐만 아니라, 여러 요청들을 서버에 보내게 되는데, 각 요청들을 일일이 대응하는 것은 비효율적일 것이다.

그렇기에 각각의 요청들을 담당하는 서버에게 요청이 잘 전달될 수 있도록 교통정리를 해주는 체계가 'API'이다.

어떠한 방식으로 정보를 요청해야 하는지, 그리고 그러한 요청을 보냈을 때 어떠한 형식으로 무슨 데이터를 전달받을 수 있는지에 대해서 정리한 일종의 규격이라고 볼 수 있다.

API의 풀네임은 Application Programming Interface로서 애플리케이션이 인터페이싱(요청과 응답을 주고받는) 체계라고 이해하면 된다.

API 구현 및 형식

API 구현 방법

: API를 작성하는 다양한 방법이 있으나, 가장 많이 사용하는 방법은 REST API이며, 아래에 더 자세하게 다루어보도록 하겠다

API 결과(데이터) 제공 형식

: 주고 받는 데이터 형식은 주로 'JSON', 'XML'이다. 요청의 결과로 받는 데이터의 구조에도 통일감을 줄 수 있도록 공통의 포맷을 정한 것으로, 최근에는 JSON 형태를 많이 사용하고 있다.

  • JSON(JavaScript Object Notation) 이란?
    : JSON은 사람이 읽을 수 있고 시스템에서 구문 분석할 수 있는 방식으로 데이터를 저장하고 교환하기 위한 텍스트 기반 형식이다. 결과적으로 JSON은 비교적 쉽게 학습하고 문제를 해결할 수 있다.

    JSON과 HTML, XML 비교

    • JSON: 일반적으로 데이터 저장 및 전송에 사용된다. JSON은 간단하고 사용하기 쉬운 데이터 형식의 이점을 누릴 수 있는 애플리케이션을 위해 널리 사용되는 선택이다.
    • XML(Extensible Markup Language) : 보다 복잡한 데이터 구조를 허용하는 JSON과 유사한 범용 마크업 언어이다.
    • HTML : 웹 페이지의 구조 및 콘텐츠를 생성하는데 사용된다. CSS와 JavaScript와 같은 다른 언어와 함께 웹 사이트의 스타일을 통합하고 페이지에 상호 작용을 추가하는데 사용되는 경우가 많다.

API 활용 방법

: API 문서란, 각 기업이 만든 API의 사용법이 담긴 일종의 API 매뉴얼로, 어던 기능을 불러 올 수 있는지, 각 기능에 필요한 정보를 받아오기 위해서는 어떠한 방식으로 요청해야 하는지 등이 상세히 기술되어 있다.

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

    Represent가 '표현하다'는 뜻인 점을 염두에 두면, '요청 자체만 보고 내가 무엇을 원하는지 알게 하자(=요청 자체로 나를 '표현'하자')는 사상으로 등장하였다.

    클라이언트와 서버는 고유한 url(링크)을 통해 요청과 응답을 주고받게 되는데 이 url만 보면 어떤 요청인지 바로 추론할 수 있다.

    즉 REST란

  1. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
  2. HTTP Method(Post, Get, Put, Delete, Patch 등)를 통해
  3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미한다.

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

  • REST 구성 요소

    • 자원(Resource) : HTTP URI
    • 자원에 대한 행위(Verb) : HTTP Method
    • 자원에 대한 행위의 내용(Representations) : HTTP Method Pay Load
  • REST의 특징

    • Server-Client(서버-클라이언트 구조)
    • Stateless(무상태)
    • Cacheable(캐시 처리 가능)
    • Layered System(계층화)
    • Uniform Interface(인터페이스 일관성)
  • REST의 장단점

    • 장점
      • HTTP 프로토콜의 인프라를 그래도 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
      • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
      • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다
      • Hypermedeia API의 기본을 충실히 지키면서 범용성을 보장한다
      • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다
      • 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다
      • 서버와 클라이언트의 역할을 명확하게 분리한다
    • 단점
      • 표준 자체가 존재하지 않아 정의가 필요하다
      • HTTP Method 형태가 제한적이다
      • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다
      • 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다(익스플로어)

API 필요성

  • 개발 및 관리의 효율성
    : API를 사용하면, 실제로 서비스가 어떻게 구현되었는지는 몰라도 그 서비스를 그대로 가져다 사용할 수 있다.
    즉, 매번 새로운 개발을 할 필요 없이 이미 만들어 놓은 기능을 그대로 '블록'처럼 가져다 쓸 수 있다
    덕분에 개발 시간이 줄어들고 개발에 필요한 비용도 아낄 수 있다 또한, API 문서만 보면 누구나 쉽게 이해할 수 있어, 협업에 용이하고 유지보수도 수월하다

  • 유연성, 확장성
    : 서비스의 신규 개발과 웹/앱 등 채널 확장이 쉽다. 특히 타사 서비스와의 연계에 있어 가장 큰 장점을 자랑한다.

Open API란?

: Open API는 말 그대로 '누구나 쓸 수 있도록 공개된(open) API'를 의미한다
Open API가 유행하는 이유는, 아무래도 플랫폼의 영향력이 곧 돈이 되기 때문이다. 자사의 서비스가 타사의 다양한 서비스에서도 활용된다면, 사용자 수가 증가하는 등 서비스 자체의 가치도 높아질 것이며, 또한 API를 통해 새로운 수익원을 창출하는 것도 기업들이 Open API를 도입하는 주요 동인 중 하나이다.
API의 호출 수에 제한을 두고, 무료 제공량 이상은 돈을 받는다거나(단계적 유료화), 자사가 구축한 결제 시스템을 API 형태로 타사 서비스에 연계할 수 있도록 하여 수수료 수익을 창출하는 등이 있다


용어

  • PAYLOAD : 페이로드(payload)는 전송되는 데이터를 의미한다.
    • 데이터를 전송할 때, 헤더와 메타 데이터, 여러 체크 비트 등과 같은 다양한 요소들을 함께 보내어, 데이터 전송의 효율과 안정성을 높이데 된다
    • 이때, 보내고자 하는 데이터 자체를 의미하는 것이 바로 페이로드이다.

Reference

API 이해하기(KAKAO API)
REST API

profile
대한민국의 미래를 묻는다면 고개를 들어 나를 쳐다보거라

0개의 댓글