REST API란?

REST API

REST - API

• REST = Representational State Transfer
  기계와 기계가 규격화된 방식으로 인터넷이나, 웹을 통해서 통신할수 있도록 돕는 통신 규칙 이며, 웹의 통신 규약인HTTP 를 사용한다.
• API = Application Program Interface
  컴퓨터의 기능을 실행시키는 방법

print("Hello world"); //python

document.write('Hello world'); //java script

REST의 구성 요소

1.자원(Resource) : URI

• 모든 자원에는 고유한 ID가 존재하고 이 자원은 server에 존재한다.
• HTTP 처럼 URI로 자원을 구별한다.
  uri : 통합 자원 식별자로서 인터넷에 있는 자원을 나타내는 유일한 주소.

2.행위(Verb) : HTTP Method

HTTP의 프로토콜의 Method를 그대로 사용한다. (아래의 Resource가공 방법 참고)

3.표현(Representation of Resource)

Client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation) 을 보낸다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS등 여러 형태의 Representation으로 나타난다.

Resource

• Rest API는 컴퓨터가 가지는 데이터들을 Resource라고 칭한다.
• 또한 Resource는 uri를 통해 REST API 로 식별한다.

Collection : example.com/topics
topic이라는 정보 전체를 식별하는 uri이다, 이러한 REST API를 Collection이라고 부른다.

Element : example.com/topics/1
topic의 정보 하나를 식별하는 uri이다, 이러한 REST API를 Element라고 부르며, Element가 모여 Collection을 이룬다, 또한 id값을 사용하는 것이 일반적 이다.

REST API에서의 Resource 가공 방법

• 기존의 정보 가공 방법에는 CRUD 4가지가 존재한다.
• rest api에서는 이러한 정보 가공 방법을 method라 부라고 부른다. (http의 메소드를 가져옴)

기존 정보 가공 방법	REST API에서 정보 가공 방법	역할
Create	post	생성
Read	get	조회
Update	put	전제 내용 수정
Update	patch	부분 내용 수정
Delete	delete	삭제

REST의 특징 (제약조건)

1.Server-Client 구조

Resource가 있는 쪽을 Server, resource를 요청하는 쪽을 Client라고 부른다.

2.Stateless(무상태)

HTTP 프로토콜은 무상태 프로토콜이므로, 그를 사용하는 REST API역시 무상태성을 가진다.

3.Cacheable(캐시 처리 기능)

HTTP 프로토콜을 사용하므로, 웹에서 사용하는 기존의 기능을 사용할수 있다.

4.Layered System(계층화)

Client는 REST API Server만 호출 한다.
REST Server은 다중 계층으로 구성될 수 있다.

5.Code-On-Demand(Optional)

Server로부터 스크립트를 받아서 Client에 실행한다.

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

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.

REST의 장단점

장점

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

단점

• 표준자체가 존재하지 않아 정의가 필요하다.
• 사용할 수 있는 메소드가 4개 뿐이다.
• HTTP 메소드 형태가 제한적 이다.
• 구형 브라우저에서는 호환이 되지 않는다.(익스플로러)

REST API

• REST를 기반으로 API서비스를 구현한 것이다. 즉, 남의 컴퓨터의 기능을 실행시키는 방법 이다.

예를들어, 구글캘린더에 등록되어 있는 정보를 웹과, 인터넷을 통해 일정 추가, 수정, 삭제 하는 기능이다.

• REST API의 경우 특정한 기술이 아닌, HTTP 를 최대한 HTTP답게 사용하기 위함.

REST API 설계 규칙

1.URI는 동사보다 명사, 대문자보다 소문자

http://jindream6128.tistory.com/Post*_1/

2.마지막에 슬래시(/) 를 포함하지 않는다.

http://jindream6128.tistory.com/Post_1 /

3.언더바 대신 하이폰(-) 을 사용한다.

http://jindream6128.tistory.com/Post_1 /

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

http://jindream6128.tistory.com/post-1/photo .jpg

5.행위를 포함하지 않는다.

http://jindream6128.tistory.com/delete-Post_1 /

HTTP 응답 상태 코드

• 잘 설계된 REST API의 경우 URI만 잘 설계 된것이 아닌, Resource에 대한 응답을 잘 내어주는것 까지 포함하여야 한다.

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

References

생활코딩, Rest API
네트워크, REST API
Network, Rest란?, Rest API란?, RESTful이란?
REST API 제대로 알고 사용하기
네트워크, REST API란? REST, RESTful이란?
REST API 제대로 알고 사용하기