REST API)

REST API) 애플리케이션 통신

오늘날 PC, 모바일기기 등등 다양한 기기간의 상호 운용성이 기본 기능으로 제공되어야 합니다. 따라서 각기 다른 애플리케이션 간에 통신이 필요합니다.

즉, 모든 애플리케이션이 기본 운영체제 및 프로그래밍 언어에 의존하지 않고 다른 애플리케이션과 통신할 수 있어야 합니다. 

웹서비스

웹서비스는 애플리케이션과 시스템이 인터넷을 통해 데이터를 교환하는 데 사용하는 표준 및 프로토콜 모음입니다. 웹서비스는 모든 프로그래밍 언어로 작성될 수 있으며 운영체제에 독립적입니다.

REST란?

REpresentational State Transfer의 약자.

2000년도 로이필딩이 박사학위 논문에서 최초 소개

클라이언트와 서버의 동작을 제어하는 기본 특성 및 프로토콜을 제공하는 상태 비저장 소프트웨어 아키텍처

일반 웹통신은 client에서 server에 url로 요청을 하게 됩니다. url은 프로토콜(https)과 host(domain명), resource(자원, 위치?)로 구성되어 있죠.

url로 요청서를 받은 웹서버는 데이터베이스에서 데이터를 가져와 클라이언트에게 html, image, xml, json 형태로 response 해줍니다.

REST 통신은 client에서 webserver에 verb+URL 형태로 요청을 합니다. 즉, 이 verb, 동사형태로 어떤 요청을 하는지 보내주는겁니다. 이 부분에서 차이가 있습니다.

verb

- get : 읽기

- post : 생성

- put : 수정

- delete : 제거

RESTfull 서비스

RESTful 웹서비스는 HTTP 프로토콜과 REST의 원칙을 사용하여 구현된 웹서비스입니다. 리소스의 집합은 유효한 하이퍼텍스트 표준인 모든 유효한 인터넷 미디어 유형이 될 수 있는 표준화된 형식(XML, JSON)으로 표현됩니다.

REST는 크게 3가지로 구성되어 있습니다.

- 자원: URI

- 행위: HTTP 메서드(get/post/put/delete 등)

- 표현: 

REST 특징

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

2. 무상태성 : 상태정보(세션정보, 쿠키정보)를 따로 저장하고 관리하지 않아 서비스의 자유도가 높고 서버의 구현이 단순해집니다.

3. 캐시 가능 : http라는 기존 웹표준을 그대로 사용하기 때문에 웹에서 사용하는 기존 인프라를 그대로 활용 가능합니다.

4. 자체 표현 구조: REST AI 메시지만 보고도 이를 쉽게 이해할 수 있다.

5. client-server구조: REST 서버는 API를 제공하고 클라이언트는 사용자 인정이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.

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

RES API 디자인 가이드

1. URI는 정보의 자원을 표현해야 한다.

- 리소스 이름은 동사보다는 명사를 사용

- 슬래시 구분자는 계층 관계를 나타내는 데 사용

- uri 마지막 문자는 슬래시를 포함하지 않는다.

- 하이픈은 URI 가독성을 높이는데 사용

- 언더바는 URI에 사용하지 않습니다. ( 가독성 측면 )

- 대소문자가 구별되기 때문에 URI 경로에는 소문자가 적합

- 파일 확장자는 URI에 포함시키지 않는다.

- 리소스 간의 관계 표현 : /리소스명/리소스ID/관계가 있는 다른 리소스명

  관계명이 애매하거나 구체적인 표현이 필요할 때는 명사를 나열하는 식으로 해결

ex) /users/{userid}/likes/devices : 사용자가 좋아하는 디바이스 목록

- collection과 document : 컬렉션은 문서들의 집합, 객체들의 집합이고, 문서는 하나의 객체, 하나의 문서입니다. ( 단/복수 구별)

2. 자원에 대한 행위는 HTTP Method로 표현한다.

- HTTP 응답 상태 코드를 잘 내어주어야 한다.

200 : 클라이언트의 요청이 정상적으로 수행된 경우

201 : 클라이언트가 어떠한 리소스 생성을 요청, 해당 리소스가 성공적으로 생성된 경우(POST)

301 : 클라이언트가 요청한 리소스에 대한 URI가 변경되었을 때 사용되는 응답(응답 시 Location header에 변경된 URI를 적어줘야 함)

400 : 클라이언트의 요청이 부적절할 경우

401 : 클라이언트가 인증되지 않은 상태에서 보호된 리소스를 요청했을 때(보통 로그인 문제)

403 : 유저 인증상태와 관계없이 응답이 불필요한 리소스를 클라이언트가 요청했을 때(400, 404 사용 권고/ 403 자체는 리소스가 있다는 뜻이기 때문에)

404 : 클라이언트가 요청한 리소스에서 사용 불가능한 메서드를 이용했을 경우

500 : 서버에 문제가 발생할 경우