REST API란?
• Representational State Transfer의 약자. 소프트웨어 프로그램 아키텍처의 한 형식으로 자원의 표현으로(이름으로) 구분하여 해당 자원의 정보(상태)를 주고 받는 모든것을 의미.
• 월드 와이드 웹(WWW)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식.
• REST는 기본적으로 웹의 기존 기술과 HTTP프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용 할 수 있는 아키텍처 스타일
REST의 구체적인 개념
• HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE) 를 통해 해당 자원에 대한 CRUD Operation을 적용하는것을 의미.
• 즉, REST는 자원 기반의 구조 (ROA: Resource Oriented Architecture) 설계의 중심에 Resource가 있고, HTTP Method를 통해 해당 자원 Resource를 처리하도록 설계된 아키텍처를 의미.
• 웹의 모든 자원에 고유한 ID인 HTTP URI를 부여.
※ CRUD Operation 이란?
- Create: 생성(POST)
- Read: 조회(GET)
- Update: 수정(PUT)
- Delete: 삭제(DELETE)
- Head: hearder 정보 조회(HEAD)
REST 장단점
1) 장점
• HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API사용을 위한 별도의 인프라를 구출 할 필요가 없음.
• HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해줌.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용 가능
• Hypermedia API의 기본을 충실히 지키면서 범용성을 보장.
• REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악 할 수 있음.
• 여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
• 서버와 클라이언트의 역할을 명확하게 분리한다.
2) 단점
• 표준이 존재하지 않는다.
• 사용 할 수 있는 메소드가 4가지 밖에 없고, HTTP Method의 형태가 제한적이다.
• 브라우저를 통해 테스트 할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
• 구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다. ex) PUT, DELETE를 사용하지 못하는점.
pushState를 지원하지 않는 점
REST가 필요한 이유
• 애플리케이션 분리 및 통합 / 다양한 클라이언트의 등장(최근의 서비스/ 애플리케이션 개발 흐름은 멀티 플랫폼, 멀티 디바이스 시대로 넘어와 있어 단순히 하나의 브라우저만 지원하면 되었던 이전과는 다르다)
• 최근의 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야함.
• 이러한 멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었음. 따라서 플랫폼에 맞추어 새로운 서버를 만드는 수고를 들이지 않기 위해 범용적으로 사용성을 보장하는 서버 디자인이 필요하게 되었음.
REST 구성 요소
1) 자원(Resource): URL
• 모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재.
• 자원을 구별하는 ID는 'groups/:group_id'와 같은 HTTP URL
• 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을 통해 데이터를 주고 받는것이 일반적
| Method | 역할 |
| POST | POST를 통해 해당 URI를 요청하면 리소스 생성 |
| GET | GET를 통해 해당 리소스를 조회. 리소스를 조회하고 해당 도큐먼트에 대한 자세한 정보를 가져옴 |
| PUT | PUT를 통해 해당 리소스를 수정 |
| DELETE | DELETE를 통해 리소스를 삭제 |
REST 특징
1. 클라이언트 / 서버 구조(Server-Client)
• 클라이언트는 유저와 관련된 처리를, 서버는 REST API를 제공함으로써 각각의 역활이 확실하게 구분되고 일괄적인 인터페이스로 분리되어 작동할 수 있게 한다.
• REST Server: API를 제공하고 비지니스 로직 처리 및 저장을 책임진다.
• Client: 사용자 인증이나 context (세션, 로그인 정보) 등을 직접 관리하고 책임진다.
• 서로 간 의존성이 줄어든다.
2. 무상태성 (Stateless)
• REST는 HTTP의 특성을 이용하기 떄문에 무상태성을 갖는다.
• 즉 서버에서 어떤 작업을 하기 위해 상태정보를 기억할 필요가 없고 들어온 요청에 대해 처리만 해주면 되기 때문에 구현이 쉽고 단순해진다.
3. 캐시 처리 가능 (Cacheable)
• HTTP라는 기존 웹표준을 사용하는 REST의 특징 덕분에 기본 웹에서 사용하는 인프라를 그대로 사용 가능하다.
• 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
• 캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상 시킬 수 있다.
4. 계층화 (Layered System)
• 클라이언트와 서버가 분리되어 있기 때문에 중간에 프록시 서버, 암호화 계층 등 중간매체를 사용할 수 있어 자유도가 높다
5. 인터페이스 일관성(Uniform Interface)
• Uniform Interface는 Http 표준에만 따른다면 모든 플랫폼에서 사용이 가능하며, URI로 지정한 리소스에 대한 조작을 가능하게 하는 아키텍쳐 스타일을 말한다
• URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
• 즉, 특정 언어나 기술에 종속되지 않는다.
REST API란?
API(Application Programming Interface)란?
데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
REST API의 정의
REST 기반으로 서비스 API를 구현한 것.
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.
REST API의 특징
사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.
REST API 설계 기본 규칙
※ 참고 리소스 원형
도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소
URI는 정보의 자원을 표현해야 한다.
- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
- resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
- resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
- resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.
URI에 HTTP Method가 들어가면 안된다.
URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)
경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)
REST의 핵심 설계 목표
- 컴포넌트들간의 유연한 (쉽게 확장가능한) 상호 연동성 확보
- 범용 인터페이스
- 각 컴포넌트들의 독립적인 배포
- 지연 감소, 보안강화, 레거시 시스템을 인캡슐레이션 하는 중간 컴포넌트로의 역할
※ 인캡슐레이션: 데이터에 헤더가 추가되는 과정 즉, OS lv7 -> lv4로 내려 가는 과정을 뜻하며 간단하게 말하면 PC에서 다른 PC로 데이터를 전송할 때 데이터를 패키지화하는 과정을 말함.
1) 상호연동성 확보
• 상호연동성은 "서로 상이한 컴포넌트" 들을 쉽게 연결할 수 있는 성질을 의미한다.
상호연동성은 두 개이상의 컴포넌트들을 결합함으로써, 작업을 더 효율적으로 수행하도록 하는데 목적.
• 즉, REST는 HTTP와 URI 기반인데, HTTP와 URI 모두 표준이며, 직관적이고 사용이 간단하며 어디에서든 동일하게 작동하는 것을 보장할 수 있다.
2) 범용 인터페이스
• 상호연동성과 비슷한 개념으로 REST 모델을 위한 HTTP와 URI는 표준으로 어디서든지 사용가능한 범용 인터페이스를 제공.
• 따라서 개발자는 비즈니스 로직만 고민하면 된다.
3) 각 컴포넌트들의 독립적인 배포
• 각 컴포넌트들과의 독립적인 배포의 의미는 다른 컴포넌트들과 독립적으로 개발을 할 수 있다는 것을 의미.
• 규격에 맞추어 개발이 되었다면 다른 컴포넌트가 추가되어도 연동에 걱정할 것이 없다.
4) 컴포넌트를 중계하는 역할
• 클라이언트는 엔드 서버에 직접 연결할 필요 없이 서비스를 이용할 수 있다. 그 이유는 REST 서버가 클라이언트와 엔드 서버 중간에서 중계역할을 할 수 있기 때문.
• 이러한 중계 서버로 이용하면 로드 밸런싱, 공유 메모리 등을 이용해서 확장성/ 성능을 향상 시킬 수있으며 보안 정책을 적용하기도 용이하다.
※ 로드 밸런싱: 부하 분산이라고도 불리며 컴퓨터 네트워크 기술의 일종으로 둘 혹은 셋이상의 중앙처리장치 혹은 저장장치와 같은 컴퓨터 자원들에게 작업을 나누어 주는 것을 의미.
REST API설계 기본 규칙
1) 슬래시 구분자 ( / )는 계층 관계를 나타내는데 사용.
2) URI 마지막 문자로 슬래시 ( / )를 포함하지 않는다.
• URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것
• 역으로 리소스가 다르면 URI도 달라져야 한다.
3) 하이픈 ( - )은 URI 가독성을 높이는데 사용한다.
4) 밑줄 ( _ )은 URI에 사용하지 않는다.
5) URI 경로에는 소문자가 적합.
• URI 경로에 대문자 사용은 피하도록 한다.
6) 파일확장자는 URI에 포함하지 않는다.
• REST API 에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
• 대신 Accept Header 를 사용한다.
7) 리소스 간에 연관 관계가 있는 경우
• /리소스명/리소스ID/관계가 있는 다른 리소스 명
• ex) GET: /users/2/orders (일반적으로 소유의 관계를 표현할 때 사용)
REST API 설계 예시
| CRUD | HTTP verbs | Route |
| resource들의 목록을 표시 | GET | /resource |
| resource 하나의 내용을 표시 | GET | /resource/:id |
| resource를 생성 | POST | /resource |
| resource를 수정 | PUT | /resource/:id |
| resource를 삭제 | DELETE | /resource/:id |
RESTful 이란?
• RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어.
• REST API를 제공하는 웹 서비스를 RESTful하다고 할 수 있다.
• RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아님. 즉, REST원리를 따르는 시스템은 RESTful이란 용어로 지칭.
RESTful의 목적
• 이해하기 쉽고 사용하기 쉬운 REST API를 만드는것.
• RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없음.
Reference
• https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
'배우고 익혀 널리 알리자' 카테고리의 다른 글
| [Design Pattern] 디자인 패턴이란? (0) | 2021.10.30 |
|---|---|
| [백준] 백준으로 문제를 제출할때 주의해야할 점 (0) | 2021.10.25 |
| [function] 함수의 리턴값 (0) | 2021.10.05 |
| 티스토리 코드블럭 디자인 설정하는법 highlight.js (0) | 2021.10.02 |
| [QGIS] GeoServer Layer 생성하기 레이어 등록 QGIS연동하기 (0) | 2021.09.30 |