개발배경지식5) API와 REST API

---

API (Application Programming Interface)

API는 프로그램과 프로그램을 연결해주는 매개체이다.

네트워크를 통한 컴퓨터 간의 통신만큼, 프로그램 간의 통신 또한 굉장히 자주 이루어지곤 한다. 이때, 그 프로그램을 만드는 개발자는 해당 프로그램이 잘 통신할 수 있도록 규칙들을 잘 설계해야 한다.

여기서 다음 경우에 해당하는 경우에는 API가 프로그램 사이 중개자 역할을 해준다.

1. 접근할 프로그램의 규칙이 복잡한 경우
2. 프로그램 보안상 외부에서의 접근이 제한적이고 기능이 간접적으로 제공될 때

규칙들의 집합인 API는 프로그램의 기능을 대신해주기 때문에 해당 API가 제공하는 기능들을 미리 정리해서 규칙을 세워두면 클라이언트는 접근하고자 하는 프로그램에 대해서 자세히 알지 못하더라고 API에 따라 손쉽게 총신을 할 수 있게 된다.

API를 개발할 때는 중개해주고자 하는 프로그램의 구조와 기능을 충분히 숙지하고 규격화하는 과정이 필요하다. 잘 설계된 API를 적재적소에 이용하면 해당 프로그램에 직접 접근하지 않고도 클라이언트가 원하는 정보를 요청하고 응답받을 수 있기 때문에 개발 전반에서 널리 사용된다.

API를 제공하는 서버를 API 서버라고 하는데, 대표적으로 데이터베이스를 대신해서 로그인, 결제 기능 등을 제공하는 API 서버가 있다. 이 경우 클라이언트는 데이터베이스가 아닌 API 서버와 통신하게 된다.

---

API의 사용 사례

• 국가 등에서 제공하는 공공 데이터에 손쉽게 접근할 수 있도록 공공 데이터 포탈 등에서는 해당 공공 데이터 API를 제공하곤 한다.
• 기업의 경우 데이터베이스의 보안에 신경을 써야 하므로 클라이언트와 데이터베이스 사이에 API 서버를 두어 통신하도록 한다.

---

API 문서

API를 제공하는 주체는 해당 API의 기능과 사용 방법 등을 정리한 문서를 제공한다. 아래는 개발 시 자주 사용되는 API 중 하나인 카카오 로그인 API에 대한 API 문서이다.

[카카오 로그인 REST API]

해당 문서에서는 API를 사용하기 전 확인해야 할 사항은 물론, 어디(URL)에 무엇(Parameter)을 보냈을 때, 어떠한 응답(Respnse)을 받을 수 있는지 등 전반적인 API의 사용법 또한 문서화하여 정리해두고 있다.

API를 사용하기 전에 해당 API의 문서를 읽어보는 것은 중요한데, API의 구조와 기능을 알 수 있음은 물론, 아래처럼 변경 사항에 대한 정보도 얻을 수 있기 때문이다.

기존 API에서 사용되던 auth_type 파라미터가 prompt 파라미터로 대체되었다.

---

REST API (Representational State Transfer API)

위에서 예시로 든 카카오 로그인 API는 REST API이다. 여기서 REST API가 의미하는 바가 무엇인지, 또 REST는 무엇인지 알아보자.

REST API에 대해서 알아보기 전에, REST 가 무엇인지 알아볼 필요가 있다.

REST란

REST 란 Representational State Transfer의 약자로, 리소스의 이름(리소스의 표현)으로 구분하여 해당 자원의 상태(정보)를 주고받는 모든 것, 즉 리소스의 표현(Representation)에 의한 상태 전달을 의미한다.

상태(정보)의 전달은 보통 JSON 혹은 XML 형태로 이루어지는 것이 일반적이며, 데이터가 요청되는 시점에의 상태를 전달한다.

REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한으로 활용할 수 있는 아키텍쳐 스타일이며, 따라서 네트워크 상에서 Client와 Server 사이 주된 통신 방법 중 하나로 이용되곤 한다.

좀 더 구체적인 개념은 다음과 같다. 초심자라면 아래 내용은 넘어가도 좋다.

REST는 HTTP URI (Uniform Resource Identifier)를 통해 리소스를 명시하고, HTTP Method (POST, GET, PUT, DELETE)를 통해 해당 리소스에 대한 CRUD Operation을 적용하는 것을 의미한다. 즉, REST는 리소스 기반의 구조 (ROA, Resource Oriented Archtecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미한다고 볼 수 있는 것이다.

• CRUD Operation이란?
  • Create: 생성(POST)
  • Read: 조회(GET)
  • Update: 수정(PUT)
  • Delete: 삭제(DELETE)
  • HEAD: header 정보 조회(HEAD)

---

REST 구성 요소

1. 자원(Resource): URI
   • 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
   • 자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
   • Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.
2. 행위(Verb): HTTP Method
   • HTTP 프로토콜의 Method를 사용한다.
   • HTTP 프로토콜은 GET, POST, PUT, DELETE와 같은 메서드를 제공한다.
3. 표현(Representation of Resource)
   • Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
   • REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어질 수 있다.
   • JSON 혹은 XML를 통해 데이터를 주고받는 것이 일반적이다.

---

REST의 특징

1. Server-Client(서버-클라이언트 구조)
   • 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
     • REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
     • Client: 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   • 서로 간 의존성이 줄어든다.
2. Stateless(무상태)
   • HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
   • Client의 context를 Server에 저장하지 않는다.
     • 즉, 세션과 쿠키와 같은 context 정보를 신경 쓰지 않아도 되므로 구현이 단순해진다.
   • Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
     • 각 API 서버는 Client의 요청만을 단순 처리한다.
     • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안 된다.
     • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
     • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.
3. Cacheable(캐시 처리 가능)
   • 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
     • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
     • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
   • 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
   • 캐시 사용을 통해 응답 시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답 시간, 성능, 서버의 자원 이용률을 향상할 수 있다.
4. Layered System(계층화)
   • Client는 REST API Server만 호출한다.
   • REST Server는 다중 계층으로 구성될 수 있다.
     • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
     • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상할 수 있다.
   • PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.
5. Code-On-Demand(optional)
   • Server로부터 스크립트를 받아서 Client에서 실행한다.
   • 반드시 충족할 필요는 없다.
6. Uniform Interface(인터페이스 일관성)
   • URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
   • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
     • 특정 언어나 기술에 종속되지 않는다.

---

REST의 장단점

• 장점
  • HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
  • HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해 준다.
  • HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
  • REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
  • 여러 가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
  • 서버와 클라이언트의 역할을 명확하게 분리한다.
• 단점
  • 표준이 존재하지 않는다.
  • 사용할 수 있는 메서드가 4가지 밖에 없다.
  • HTTP Method 형태가 제한적이다.
  • 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
  • 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
  • PUT, DELETE를 사용하지 못한다.
  • pushState를 지원하지 않는다.

---

REST가 필요한 이유

• 애플리케이션 분리 및 통합
• 다양한 클라이언트의 등장

최근의 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다. 따라서 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍쳐를 세우고 이용하는 방법이 필요한데, 이 중 대표적인 것이 REST이다.

---

REST API란

위에서 설명한 REST를 기반으로 서비스 API를 구현한 것을 REST API라고 한다.

구글 맵, 공공 데이터 등에서는 누구나 사용할 수 있도록 API를 공개하기도 하는데 이러한 OpenAPI나 마이크로 서비스 등을 제공하는 업체 대부분은 REST API를 제공한다.

---

REST API의 특징

• 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
• REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
• 즉, REST API를 제작하면 델파이 클라이언트뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

---

REST API 설계 기본 규칙

1. 슬래시 구분자(/ )는 계층 관계를 나타내는 데 사용한다. Ex) http://restapi.example.com/houses/apartments
2. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
   • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
   • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.
     • Ex) http://restapi.example.com/houses/apartments/ (X)
3. 하이픈(- )은 URI 가독성을 높이는 데 사용
   • 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
4. 밑줄(_ )은 URI에 사용하지 않는다.
   • 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.
5. URI 경로에는 소문자가 적합하다.
   • URI 경로에 대문자 사용은 피하도록 한다.
   • RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
6. 파일 확장자는 URI에 포함하지 않는다.
   • REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
   • Accept header를 사용한다.
     • Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
     • Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
7. 리소스 간에는 연관 관계가 있는 경우
   • /리소스명/리소스 ID/관계가 있는 다른 리소스명
     • Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

---

RESTful

REST API를 공부하다 보면 RESTful 이란 용어를 접할 수 있는데, 이는 일반적으로 REST 아키텍쳐를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어로, REST를 REST 답게라는 정신을 담고 있는 용어이다.

공식적으로 발표된 단어는 아니며, REST 원리를 따르는 시스템 전반을 의미하기 위해 사용되는 숙어 같은 개념이다.

이해하기 쉽고 사용하기 쉬운 REST API를 RESTful 한 API라고 하는데, 이를 구현하는 근본적인 목적은 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이므로, 성능이 중요한 상황에서는 굳이 RESTful 한 API를 구현할 필요는 없다.

 

+) RESTful 하지 못한 경우

• CRUD 기능을 모두 POST로만 처리하는 API
• route에 resource, id 외의 정보가 들어가는 경우