Rest API

Rest API란?

Rest API에서 API란 Application Programming Interface의 약어로 애플리케이션이나 디바이스가 서로 간에 연결하여 통신할 수 있는 방법을 정의하는 규칙 세트입니다.
Rest란 REpresentational State Transfer의 약어로 소프트웨어 프로그램 아키텍처의 한 형식입니다.
Rest API는 이러한 Rest 아키텍처를 스타일의 디자인 원칙을 준수하는 API입니다. 따라서 Rest API를 Restful API라고도 부릅니다.
Rest는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일입니다.

이미지 출처: https://www.codecademy.com/article/what-is-rest

Rest의 구체적인 개념

HTTP URI를 통해 자원을 명시하고 HTTP Method(GET, POST, PUT, DELETE 등)을 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다.
즉, REST는 자원 기반의 구조 설계의 중심에 Resource가 있고, HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처를 의미한다.
웹의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.

Rest의 구성

1. 자원(Resource) - URL

2. 행위(Verb) - HTTP Method

3. 표현(Representations)
   
   

1. 자원 (Resource) - URL

   모든 자원에 고유한 ID가 존재하고, 이 자원은 서버에 존재한다.
   자원을 구별하는 ID는 /post/post_id/1 과 같은 HTTP URI이다.

2. 행위 (Verb) - HTTP Method

   HTTP 프로토콜의 Method를 사용한다.
   HTTP 프로토콜은 GET, POST, PUT, DELETE 등의 Method를 제공한다.

3. 표현(Representation of Resource)

   Client가 자원의 상태 (정보) 에 대한 조작을 요청하면 서버는 이에 적절한 응답(Representation)을 보낸다.
   Rest에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 응답(Representation)으로 나타낼 수 있다.
   현재는 JSON으로 주고받는 것이 대부분이다.

HTTP Method의 역할

METHOD	역할
POST	POST를 통해 해당 URI를 요청하면 리소스를 생성합니다.
GET	GET을 통해 해당 리소스를 조회합니다. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옵니다.
PUT	PUT을 통해 해당 리소스를 수정합니다.
DELETE	DELETE를 통해 해당 리소스를 삭제합니다.

Rest의 특징

1. 클라이언트 / 서버 구조

   클라이언트는 유저와 관련된 처리를, 서버는 Rest API를 제공함으로써 각자의 역할이 확실하게 구분되고 일괄적인 인터페이스로 분리되어 작동할 수 있게 한다.
   클라이언트 - 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
   서버 - API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
   서로 간의 의존성이 줄어든다.

2. 무상태성 (Stateless)

   Rest는 HTTP의 특성을 이용하기 때문에 무 상태성을 가진다.
   서버에서 특정 작업을 하기 위해 상태 정보를 기억할 필요가 없고 들어온 요청에 대해 처리만 해주면 되기 때문에 구현이 쉽고 단순해진다.

3. 캐시 처리 기능 (Cacheable)

   HTTP라는 기존 웹 표준을 사용하는 특징 덕분에 기존 웹에서 사용하는 인프라를 그대로 사용 가능하다.
   대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
   캐시 사용을 통해 응답시간이 빨라지고 Rest 서버 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

4. 자체 표현 구조

   JSON을 이용한 메시지 Format을 이용하여 직관적으로 이해할 수 있고 Rest API 메시지만으로 그 요청이 어떤 행위를 하는지 알 수 있다.

5. 계층화

   클라이언트와 서버가 분리되어 있기 때문에 중간에 프록시 서버, 암호화 계층 등 중간 매체를 사용할 수 있어 자유도가 높다.

6. 유니폼 인터페이스 (Uniform)

   Uniform Interface는 Http 표준에만 따른다면 모든 플랫폼에서 사용이 가능하며 URI로 지정한 리소스에 대한 조작을 가능하게 하는 아키텍처 스타일을 말한다.
   URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
   즉, 특정 언어나 기술에 종속되지 않는다.

중심 규칙

Rest에서 가장 중요하며 기본적인 규칙은 두 가지가 있습니다.

URI는 정보의 자원을 표현해야 한다.
자원에 대한 행위는 HTTP Method (GET, POST, PUT, DELETE 등)으로 표현한다.

세부 규칙

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

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

   URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것.
   역으로 리소스가 다르면 URI도 달라져야 한다.

3. 하이픈 ( - ) 은 URI 가독성을 높이는데 사용한다.

4. 밑줄 ( _ ) 은 URI에 사용하지 않는다.

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

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

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

   Rest API에서는 메시지 마디 내용의 Format을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
   대신 Accept Header를 사용한다.
   ex) GET : http://restapi.test.com/posts/2/Accept: images/jpg

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

   /리소스명/리소스ID/관계가 있는 다른 리소스 명
   ex) GET : /users/2/posts (일반적으로 소유의 관계를 표현할 때 사용)

예시 이미지

이미지 출처: https://hackernoon.com/build-restful-api-in-go-and-mongodb-5e7f2ec4be94

설계 목표

Rest의 핵심 설계 목표는 다음과 같습니다.

1. 컴포넌트들 간의 유연한 (쉽게 확장이 가능한) 상호 연동성 확보

2. 범용 인터페이스

3. 각 컴포넌트들의 독립적인 배포

4. 지연 감소, 보안 강화, 레거시 시스템을 인캡슐레이션하는 중간 컴포넌트로의 역할

인캡슐래이션: 데이터에 헤더가 추가되는 과정 즉 OS Lv7 => Lv1로 내려가는 과정을 뜻하며 간단하게 PC에서 다른 PC로 데이터를 전송할 때 데이터를 패키지하는 과정을 말한다.

1. 상호 연동성 확보

   상호 연동성은 서로 상이한 컴포넌트들을 쉽게 연결할 수 있는 성질을 의미한다. 상호 연동성은 두 개 이상의 컴포넌트들을 결합함으로써, 작업을 더 효율적으로 수행하도록 하는데 목적이 있다.
   Rest는 HTTP와 URI 기반인데, HTTP와 URI 모두 표준이며 직관적이고, 사용이 간단하며 어디에서든 동일하게 작동하는 것을 보장할 수 있다.

2. 범용 인터페이스

   상호 연동성과 비슷한 개념으로 Rest 모델을 위한 HTTP와 URI는 웹 표준으로 어디서든지 사용 가능한 범용 인터페이스를 제공한다.
   따라서 개발자는 비즈니스 로직만 고민하면 된다.

3. 각 컴포넌트들의 독립적인 배포

   각 컴포넌트들과의 독립적인 배포의 의미는 다른 컴포넌트들과 독립적으로 개발할 수 있다는 것을 의미한다.
   규격에 맞추어 개발이 되었다면 다른 컴포넌트가 추가되어도 연동에 걱정할 것이 없다.

4. 컴포넌트를 중계하는 역할

   클라이언트는 엔드 서버에 직접 연결할 필요 없이 서비스를 이용할 수 있다. 그 이유는 Rest 서버가 클라이언트와 엔드 서버 중간에서 중계 역할을 할 수 있기 때문이다.
   이러한 중계 서버로 이용하면 로드 밸런싱, 공유 메모리 등을 이용해서 확장성 / 성능을 향상시킬 수 있으며 보안 정책을 적용하기도 용이하다.

   로드 밸런싱: 부하 분산이라고도 불리며 컴퓨터 네트워크 기술의 일종으로 둘 혹은 셋 이상의 중앙 처리 장치 혹은 저장 장치와 같은 컴퓨터 자원들에게 작업을 나누어 주는 것을 의미한다.

Restful API

Restful이란?

HTTP와 URI 기반으로 자원에 접근할 수 있도록 제공하는 애플리케이션 개발 인터페이스이다. 기본적으로 개발자는 HTTP Method와 URI만으로 인터넷에 자료를 CRUD 할 수 있다.
Rest API를 제공하는 웹 서비스를 Restful하다고 할 수 있다.
Restful은 Rest를 Rest답게 사용했다는 의미로 볼 수 있다.

Restful API 개발 원칙

1. 자원을 식별할 수 있어야 한다.

   URL (Uniform Resource Locator) 만으로 사용자가 어떤 자원을 제어하려고 하는지 알 수 있어야 한다. 자원을 제어하기 위해서 자원의 위치는 물론 자원의 종류까지 알 수 있어야 한다는 의미이다.
   서버가 제공하는 정보는 JSON이나 XML 형태로 HTTP body에 포함하여 전송시킨다.

2. 행위는 명시적이어야 한다.

   Rest는 아키텍처 혹은 방법론과 비슷하다. 따라서 이런 방식을 사용해야한다고 강제적이지는 않다. 기존의 웹 서비스처럼 GET을 이용해서 UPDATE와 DELETE를 해도 된다.
   다만 Rest 아키텍처에는 부합하지 않으므로 Rest를 따른다고 할 수 없다.

3. 자기 서술적이어야 한다.

   데이터에 대한 메타정보만 가지고도 어떤 종류의 데이터인지, 데이터를 위해서 어떤 어플리케이션을 실행해야 하는지를 알 수 있어야한다.
   즉, 데이터 처리를 위한 정보를 얻기 위해서, 데이터 원본을 읽어야 한다면 자기 서술적이지 못하다.

4. HATEOS (Hypermedia as the Engine of Application State)

   클라이언트 요청에 대해 응답을 할 때 추가적인 정보를 제공하는 링크를 포함할 수 있어야한다.
   Rest는 독립적으로 컴포넌트들을 손쉽게 연결하기 위한 목적으로도 사용된다. 따라서 서로 다른 컴포넌트들을 유연하게 연결하기 위해서 느슨한 연결을 만들어줄 것이 필요하다.
   이때 사용되는 것이 바로 링크이다. 서버는 클라이언트 응용 어플리케이션에 하이퍼링크를 제공한다.
   클라이언트는 이 하이퍼링크를 통해서 전체 네트워크와 연결되며 HATEOS는 서버가 독립적으로 진화할 수 있도록 서버와 서버, 서버와 클라이언트를 분리할 수 있게 한다.

Rest의 단점들

1. Rest는 point-to-point 통신모델을 기본으로 하기 때문에 서버와 클라이언트가 연결을 맺고 상호작용해야하는 어플리케이션의 개발에는 적당하지 않다.

2. Rest는 URI, HTTP를 이용한 아키텍처링 방법에 대한 내용만을 담고 있다. 보안과 통신규약 정책같은 것은 전혀 다루지 않는다. 따라서 개발자는 통신과 정책에 대한 설계와 구현을 도맡아서 진행해야 한다.

3. HTTP에 상당히 의존적이다. Rest는 설계 원리이기 때문에 HTTP와는 상관없이 다른 프로토콜에서도 구현할 수 있기는 하지만 자연스러운 개발이 힘들다. 다만 Rest를 사용하는 이유가 대부분의 서비스가 웹으로 통합되는 상황이기 때문에 큰 단점이 아니게 되었다.

4. CRUD 4가지 메소드만 제공한다. 대부분의 일들을 처리할 수 있지만 4가지 메소드 만으로 처리하기에는 모호한 표현이 있다.

오늘은 Rest API에 대해서 알아보았습니다. 지금까지 이러한 개념 없이 Rest API를 사용하고 있었는데 왜 사용하는지, 규칙은 어떠한 것이 있는지 등을 알 수 있던 시간이었습니다. 이러한 규칙들을 잘 생각하면서 개발하도록 노력하고자 합니다.

Reference

---

https://velog.io/@somday/RESTful-API-%EC%9D%B4%EB%9E%80