REST란? REST API란

안녕하세요 이번에는 RestApi에 대해 알아보겠습니다.

 

먼저, Rest란?

“Representational State Transfer” 의 약자로 자원을 이름으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다. 즉, 자원(resource)의 표현(representation) 에 의한 상태 전달을 의미합니다.

자원(resource)의 표현(representation) 

• 자원 : 해당 소프트웨어가 관리하는 모든 것
• ex) 문서, 그림, 데이터, 해당 소프트웨어 자체 등
• 자원의 표현 : 그 자원을 표현하기 위한 이름
• ex) DB의 음식 정보가 자원일 때, ‘food’를 자원의 표현으로 정합니다.

상태(정보) 전달 

• 데이터가 요청되어지는 시점에서 자원의 상태(정보)를 전달한다.
• JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.
• 월드 와이드 웹(www)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 개발 아키텍처의 한 형식
• REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키텍처 스타일이다.
• REST는 네트워크 상에서 Client와 Server 사이의 통신 방식 중 하나이다.

 

2. Rest의 구성

구성요소	내용	표현방법
Resource	자원	HTTP URI
Verb	자원에 대한 행위	HTTP Method
Representaions	자원에 대한 행위의 내용	HTTP Message Pay Load

 

3. Rest의 구체적인 개념

HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미합니다.

• 즉, REST는 자원 기반의 구조(ROA, Resource Oriented Architecture) 설계의 중심에 Resource가 있고 HTTP Method를 통해 Resource를 처리하도록 설계된 아키텍처를 의미한다.
• 웹 사이트의 이미지, 텍스트, DB 내용 등의 모든 자원에 고유한 ID인 HTTP URI를 부여한다.
• CRUD Operation
  Create : 생성(POST)
  Read : 조회(GET)
  Update : 수정(PUT)
  Delete : 삭제(DELETE)
  HEAD: header 정보 조회(HEAD)
   

4. Rest의 특징

Server-Client(서버-클라이언트 구조) 

• 자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
  • REST Server : API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.
  • Client : 사용자 인증이나 context(세션, 로그인 정보) 등을 직접 관리하고 책임진다.
• 서로간 의존성이 줄어든다.

 Stateless(무상태) 

• HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
• Client의 context를 Server에 저장하지 않는다.
  • 즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
• Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
  • 각 API 서버는 Client의 요청만을 단순 처리한다.
  • 즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다.
  • 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
  • Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

 Cacheable(캐시 처리 기능) 

• 웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다.
  • 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified 태스나 E-Tag를 이용하면 캐싱 구현이 가능하다.
• 대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
• 캐시 사용을 통해 응답시간이 빨리지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

 Layered System(계층화) 

• Client는 REST API Server만 호출한다.
• REST Server는 다중 계층으로 구성될 수 있다.
  • API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다.
  • 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
• PROXY, 게이트웨어 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

 Code-On-Demand(optional) 

• Server로부터 스크립트를 받아서 Client에서 실행한다.
• 반드시 충족할 필요는 없다.

 Uniform Interface(인터페이스 일관성) 

• URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
• HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
  • 특정 언어나 기술에 종속되지 않는다.

 

5. Rest의 장단점

장점

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

단점

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

6. Rest가 필요한 이유

 1. 애플리케이션 분리 및 통합

 2. 다양한 클라이언트의 등장

 3. 요즘 서버 프로그램은 다양한 브라우저와 안드로이드폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 합니다.

 

---

REST API의 개념

REST API란?

 API(Application Programming Interface)

• API란 클라이언트가 리소스를 요청할 수 있도록 서버측에서 제공된 인터페이스(interface)를 말한다.
• 이러한 API로 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 한다.
• 서버를 개발한다는 것은 API에 대한 마스터 권한이 생기는 것이다.
• API와 함께 항상 메뉴얼도 제공되어야 한다. URI를 모르면 클라는 사용할 수 없다.

REST API의 정의

REST기반의 서비스 API 어플리케이션 간의 데이터 통신을 위한 어플리케이션 프로그래밍 인터페이스

•  RESTful : REST API 제공하는 웹서비스 시스템을 지칭 , "A 서비스 시스템은 'RESTful' 하다"
•  RestTemplate : Spring에서 제공하는 REST API Server와의 HTTP 통신을 위한 객체
• 서버와 서버간의 연동을 위해 사용된다
•  Http Method : get , post , put , delete 을 지원하는 메서드를 제공한다
  • getForEntity()
  • postForObject()
  • put()
  • delete()

REST API의 특징

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

REST API 기본 설계 규칙

1. URI는 정보의 자원을 표현   ex) GET members
   1. 자원은 명사, 소문자를 사용
   2. 자원의 도큐먼트 이름으로는 단수 명사 사용
   3. 자원의 컬렉션(서버 관리 디렉터리 리소스), 스토어(클라이언트 관리 리소스 정보) 이름으로 복수 명사 사용

  2. 자원에 대한 행위는 HTTP method를 이용해 표현   ex) POST memebers/12 

1. URI에 HTTP method가 포함되면 안된다. 
2. URI에 행위에 대한 동사 표현이 들어가면 안된다. (CRUD기능을 나타내는 것은 URI에 사용하지 않는다)
3. 경로에 변하는 부분은 유링한 겂으로 대체한다. 

REST API 설계 규칙

1. 슬래시 구분자( / )는 계층 관계를 나타내는데 사용  
2. URI 마지막 문자로 / 를 포함하지 않음  
3. 하이픈( - )은 URI 가독성을 높이는데 사용  
4. 밑줄( _ )은 URI에 사용하지 않음  
5. URI 경로에는 소문자 사용  
6. 파일 확장자는 URI에 포함하지 않음  
7. 리소스의 연관관계 표현  ( / 리소스명/ 리소스 id / 관계가 있는 다른 리소스명 )

 

REST API 설계 예시

HTTP method	route	기능
GET	/resources	resource들을 표시
GET	/resources/:id	하나의 resource를 표시
POST	/resources	새로운 resource를 생성
PUT	/resources/:id	resource를 수정
DELETE	/resources/:id	resource를 삭제

 

응답 상태 코드 

1xx ( 정보 )	전송 프로토콜 수준의 정보 교환 (정보 요청, 프로세스 진행)
2xx ( 성공 )	클라이언트 요청이 성공적으로 인식되고 수행됨
3xx ( 리다이렉션 )	클라이언트 요청을 완료하기 위해 추가 작업 조치 필요
4xx ( 클라이언트 오류 )	클라이언트의 잘못된 요청 (요청 처리할 수 없음)
5xx ( 서버 오류 )	서버의 오류로 인한 유효한 요청에 대한 실패

 

Reference

---

https://meetup.toast.com/posts/92

REST API 제대로 알고 사용하기 : NHN Cloud Meetup

http://www.incodom.kr/RestFul_API#h_eba1d935e93bd5968ddc93bf569d088c

RestFul API - 인코덤, 생물정보 전문위키

 

https://creamilk88.tistory.com/184

[REST API] REST / REST API 개념과 적용 + 코드 예제 (SpringBoot 기반)

 

https://dodop-blog.tistory.com/272#recentEntries

RESTful API