API, RESTful API

API

Application Programming Interface

Interfae

어떠한 두가지가 서로 연결되고 영향을 미칠 수 있는 장소/방법/상황

Application Programming Interface

응용프로그램 간에 데이터를 주고 받는 방법

애플리케이션끼리 연결해주는 매개체이자 약속이라고도 볼 수 있다.

Server API

• 데이터를 주고 받는 양식
• 인증
• 호출제한

Open API

• 빠르고 유연한 비지니스 구축
• 비즈니스 품질 향상
• 생태계 확립
• 적은 비용

 

 

 

예시

알라딘 오픈 API 매뉴얼

쿠콘닷넷 - 핀테크 API 플랫폼

IBM API Connect

 

REST

REpresentational State Tranfer

 

자원을 이름(자원의 표현)으로 구분해 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미.

즉, 자원(resource)의 표현(representation)에 의한 상태 전달을 뜻한다.

• 자원: 해당 소프트웨어가 관리하는 모든 것 (문서, 그림, 데이터, 해당 소프트웨어 자체 등)
• 표현: 그 자원을 표현하기 위한 이름 (DB의 학생 정보가 자원이면, 'student'를 자원의 표현으로 정함)
• 상태 전달: 데이터가 요청되는 시점에 자원의 상태를 전달한다. (JSON 혹은 XML을 통해 데이터를 주고 받는 것이 일반적)

REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에, 

웹의 장점을 최대한 활용할 수 있는 아키텍쳐 스타일이다.

REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나

 

쉽게 말하면 URI, Headers, Method 등 네트워크 표현 수단을 사람이 봐도 이해하기 쉬운 표현으로 정의한다고 이해하면 된다.

 

따라서 API 문서는 중요하다. 실제로 큰 기업에서는 테크니컬 라이터가 따로 존재할 정도 (개발자가 쓰고 검사도 받음)

 

관련 참고 자료: 로이 필딩 논문

 

REST의 구성 요소

1. 자원(Resource) - URI

• 모든 자원에는 고유한 ID가 존재하고, 이 자원은 Server에 존재
• 자원을 구별하는 ID는 '/exgroups/:exgroup_id'와 같은 HTTP URI
• Client는 URI를 이용해 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청

2. 행위(Verb) - Method

• HTTP 프로토콜의 Method를 사용
• HTTP 프로토콜은 GET, POST, PUT, PATCH, DELETE의 Method를 제공. (CRUD) 그 밖에도 더 있지만 주로 이 5가지를 사용

GET	Read: 정보 요청, URI가 가진 정보를 검색하기 위해 서버에 요청
POST	Create: 정보 입력, 클라이언트에서 서버로 전달하려는 정보를 보낸다.
PUT	Update: 정보 업데이트, 주로 내용을 갱신하기 위해 사용. (데이터 전체를 바꿀 때)
PATCH	Update: 정보 업데이트, 주로 내용을 갱신하기 위해 사용. (데이터 일부만 바꿀 때)
DELETE	Delete: 정보 삭제. (안전성 문제로 대부분 서버에서 비활성화한다.)

3. 표현 (Representation of Resource)

• Client와 Server가 데이터를 주고받는 형태로 JSON, XML, TEXT, RSS 등이 있다.
• JSON, XML을 통해 데이터를 주고 받는 것이 일반적
• HTTP에서는 Content-Type이라는 헤더를 통해 표현 방법을 서술한다.

 

REST의 특징

• 유니폼 인터페이스: HTTP 표준만 따르면 어떤 언어나 플랫폼에서 사용해도 사용이 가능한 인터페이스 스타일. 
  특정 언어에 상관없이 사용 가능
• Stateless(상태 정보 유지 x): Rest는 상태 정보를 유지하지 않는다. 서버는 각각의 요청을 완전히 다른 것으로 인식하고 처리한다.
• Cacheable(캐시가능): HTTP라는 기존 웹 표준을 그대로 사용하기 때문에 기존 인프라를 그대로 활용 가능하다. 
  그래서 HTTP가 가진 캐싱 기능이 적용 가능
• Self-descriptiveness(자체 표현 구조): REST API 메시지만 보고도 쉽게 이해 할 수 있는 자체 표현 구조로 되어있다.

 

REST의 장단점

장점

• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구축할 필요가 없다.
• HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
• Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다. 
• REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
• 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.

단점

• 표준이 존재하지 않는다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
• 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.

 

RESTful API

RESTful API의 개념

RESTful은 일반적으로 REST라는 아키텍쳐를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어.
'REST API'를 제공하는 웹 서비스를 'RESTful'하다고 할 수 있다.

RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

 

RESTful API의 목적

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것

RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라

일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 

굳이 RESTful한 API를 구현할 필요는 없다. ex) 게임 업계

 

RESTful API의 특징

사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.

 

RESTful API 설계 규칙

1. 슬래시 구분자(/)는 계층 관계를 나타내는데 사용한다.

ex) http://restapi.example.com/houses/apartments

 

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 

리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.

2. URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다. 

ex) http://restapi.example.com/houses/apartments/  # X 끝에 슬래시는 쓰지 말기

3. URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피하도록 하자.

RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정.

4. 파일확장자는 URI에 포함하지 않는다.

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.

5. Accept header를 사용한다. 

ex) http://restapi.example.com/members/soccer/345/photo.jpg  # X 확장자 포함시키지 말기

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg
# 이렇게 헤더를 통해

 

6. 리소스 간에 연관 관계가 있는 경우

/리소스명/리소스ID/관계가 있는 다른 리소스명

GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

응답 상태 코드

1xx: 전송 프로토콜 수준의 정보 교환
2xx: 클라이언트 요청이 성공적으로 수행됨
3xx: 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx: 클라이언트의 잘못된 요청
5xx: 서버쪽 오류로 인한 상태 코드

 

RESTful 하지 못한 경우

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

 

GraphQL

GraphQL이란?

정보를 요청하는 쪽에서 원하는 형태로 정보를 가져오고 수정할 수 있는 Query Language

 

GraphQL이 해결한 것

기존의 REST API로는 이것들을 일일이 구현하는 것이 힘들었다.

하지만 사용하게 됨으로 아래 사항들에 대해 해결이 가능해졌다.

Over-Fetching

• 필요한 정보보다 더 많은 데이터를 전달 받는 것
• 불필요한 리소스 낭비가 발생
• 필요한 정보만 골라내는 추가 작업이 발생

Under-Fetching

• 필요한 데이터를 만들기 위해 여러 번의 호출이 필요
• 추가적인 리소스 요청이 발생
• 여러 요청을 통해 전달 받은 정보를 조합하는 추가 작업이 발생

꾸준히 사용량이 증가하는 추세이기 때문에 기회가 된다면 한 번 사용해보는 것도 좋을 것 같다.

실제로 요구 스펙에 GraphQL 경험이 적혀있는 곳도 많았던 걸로 기억.