Notice
Recent Posts
Recent Comments
Link
«   2025/03   »
일 월 화 수 목 금 토
1
2 3 4 5 6 7 8
9 10 11 12 13 14 15
16 17 18 19 20 21 22
23 24 25 26 27 28 29
30 31
Tags
more
Archives
Today
Total
관리 메뉴

MyPrograming

REST API 본문

웹 구조

REST API

SeongWon 2020. 7. 16. 03:27
반응형

1. REST의 개념

 

1-1) REST (Representational State Transfer)

 

HTTP URI를 통해 자원을 명시하고, HTTP Method를 통해서 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. 즉 자원 기반의 구조설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍쳐를 의미하는 것이다.

 

  • HTTP Method - POST, GET, PUT, DELETE
  • CRUD Operation - 데이터의 기본적인 처리에 대한 Create, Read, Update, Delete 기능을 일컫는 말

이러한 REST가 필요한 이유는 애플리케이션의 분리 및 통합, 다양한 클라이언트의 등장으로 인해 최근의 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 하기 때문이다. 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이러한 방법을 모색한 결과, REST에 관심이 쏠리게 된 것이다.

 

1-2) REST의 특징

 

① Uniform (유니폼 인터페이스)

: Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 의미한다. 

 

② Stateless (무상태성)

: REST는 무상태성 성격을 갖는다. 작업을 위한 상태정보를 따로 저장하고 관리하지 않는다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 요청이 들어오면 단순히 처리만 하면 되기 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해진다.

 

③ Cacheable (캐시가능)

: REST의 가장 큰 특징 중 하나는 HTTP 기존 웹 표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용할 수 있다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능하다는 것이다.  HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.

 

④ Self-descriptiveness (자체 표현 구조)

: REST API 메세지만 보고도 이를 쉽게 이해할 수 있는 자체 표현구조로 되어있다.

 

⑤ Client - Server 구조

: REST 서버는 API 제공, 클라이언트는 인증이나 Context (세션, 로그인 정보) 등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 떄문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성을 줄일 수 있다.

 

⑥ 계층형 구조

: REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 Proxy, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 한다.

 

 

2. REST API란?

 

API(Application Programming Interface)란 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간의 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것이다. 따라서 REST API는 REST 기반으로 서비스 API를 구현한 것이다.

 

이러한 REST API를 통해 사내 시스템들도 REST 기반으로 시스템을 분산하여 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있으며, HTTP 표준을 기반으로 구현하기 때문에 HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다는 장점이 있다.

 

2-1) REST API 설계 기본 규칙

 

① 슬래시 구분자(/)는 계층관계를 표현하는데 사용한다.

http://restapi.example.com/houses/apartments
http://restapi.example.com/animals/mammals/whales

 

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

  • URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
  • REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.

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

  • 불가피하게 긴 URI를 사용할 경우, 쉽게 읽고 해석하기 위해서 하이픈을 사용하여 가독성을 높인다.

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

 

⑤ URI 경로는 소문자를 사용하는 것이 적합하다.

  • URI 경로에 대문자 사용은 피하도록 한다. 대소문자에 따라 다른 리소스로 인식하게 되기 떄문이다.

⑥ 파일 확장자는 URI에 포함시키지 않아야 하고, Accept header를 사용한다.

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 (O)

 

⑦ 리소스 간의 연관 관계를 표현해야할 경우, 다음과 같은 표현방법을 사용한다.

/리소스명/리소스 ID/관계가 있는 다른 리소스명
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

 

2-2) REST API 설계 예시

 

출처 : https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

 

 

3. RESTful이란?

 

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

 

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

 

※ RESTful 하지 못한 경우

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