[SWA/RESTful API] RESTful API

RESTful API라는 것은 시스템이 인터넷을 통해서 정보를 교환할때 사용하는 인터페이스이다.

소프트웨어끼리 통신할때 사용하는 표준이라고 생각하면 된다.

추가적인 설명을 보자

---

1. API란?

application programing interface 즉 API는 소프트웨어끼리 통신할때 지켜야할 것들이 있다면 이를 정의한 규칙이다.

데이터를 어떤 방식으로 주고 받을 지 정하는 방식이다.

웹 API는 2가지 계층으로 나뉘게 되는데 

• 클라이언트
  웹에서 정보에 엑세스 하려고하는 사용자이다.
• 리소스
  다양한 애플리케이션이 클라이언트에 제공하는 데이터이다. 이떄 클라이언트에게 데이터를 전송하는 시스템을 server라고 한다.

장점으로는 리소스의 출처에 대해서 자세히 알 필요가 없다는 것에 있다.

---

2. REST란?

REST란 Representational State Transfer란 영어로 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처이다.웹의 기존 기술과 HTTP프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 사용가능하다.

클라이언트와 서버간에 통신할때 자원의 이름으로 구분해서 자원의 상태 즉 정보를 주고 받는 것을 의미한다.

REST의 구성 요소를 보자

• 자원 (Resource) :URI
  모든 자원에는 고유한 ID가 존재하고 이는 Server에 존재한다.
  자원의 ID는 HTTP URI이며 '/groups/:group_id' 와 같이 존재한다.
  client는 이 URI를 이용해서 자원을 지정하고 이 정보(상태)에 대한 조작을 Server에 요청한다.
• 행위(Verb) : HTTP Method
  HTTP의  Method인 GET,POST,PUT,DELETE같은 메소드를 말한다.
• 표현(Representation of Resource)
  Client가 자원의 상태에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
  JSON, XML, TEXT, RSS등의 응답으로 보내며 주로 사용하는건 아래의 2가지 형식을 사용한다.
  JSON (JavaScript Object Notation):
  간결하고 가독성이 좋다. 자바슨크립트 객체와 유사한 구조를 가지고있다. 숫자, 문자열, 배열, 객체 등을 표현할 수 있다. 
  XML (eXtensible Markup Language):
   계층구조를 가지고 있어서 복잡한 데이터를 표현하기 쉽다. 확장성이 높아서 다양한 데이터 유형을 표현할 수 있으며 HTML과 유사한 태그 구조를 가지고 있다.

HTTP URL를 통해서 자원을 명시하고 HTTP Method(POST, GET, PUT, DELETE)를 통해서 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. HTTP에 관한 더 많은 내용은 아래 링크를 참고하자

[HTTP/기초] HTTP

 

장점 :

• HTTP의 것들을 그대로 사용해서 별도로 인프라를 구성할 필요가 없다.
• HTTP 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다. 즉 다양한 클라이언트에서 사용 가능하다.
  이는 브라우저, 안드로이드, 아이폰등등의 멀티 플랫폼에 대한 지원을 더 쉽게 한다.
• REST API 메세지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악 가능하다.
• 서버와 클라이언트의 역할을 명확하게 분리해준다.

단점 :

• 표준이 없다.
• HTTP의 메소드의 종류가 적은 만큼 형태가 제한적이다.

---

3. REST의 특징

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

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

Stateless(무상태) :

• HTTP 프로토콜은 Stateless Protocal이라 REST역시 무상태성을 갖는다.
• 무상태성이란 서버가 클라이언트로부터 요청을 받을 때 마다 해당 요청을 처리하기 위해서 이전에 발생한 요청이나 세션 정보를 유지하지 않는다는 것을 의미한다.
• Client의 context의 정보를 신경쓰지 않아서 구현이 단순해진다.
• Server는 각각의 요청을 완 전별개의 것으로 인식한다.
• 이는 처리 방식에 일관성ㅈ을 부여하고 부담이 줄어들며 서비스의 자유도가 올라간다.

Cacheable(캐시 처리 가능)

• HTTP가 가진 기능인 캐싱 기능을 사용할 수 있다. Las-Modified 태그나 E-Tag를 사용하면된다.
• 대량의 요청을 빠르게 처리하도록 캐시가 요구된다.
• 캐사를 통해서 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않아 서버 성능이 올라간다.

Layered System(계층화)

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

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

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

---

 

4. REST API

REST기반으로 서비스 API를 구현한 것이다.

인터넷같은 곳에서 주로 사용할수 있는 api들은 REST API형식을 따른다(공공데이터, 구글 맵)

MSA 마이크로 서비스 아키텍처등도 REST API를 사용해서 확장성 재사용성을 높이는 아키텍처이다.

 

그럼이제 설계 규칙을 알아볼텐데 그전에 알아야할 용어가 3가지가있다.

1. 도큐먼트:  객체 인스턴스나 데이터베이스 레코드와 유사한 개념
2. 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
3. 스토어 : 클라이언트에서 관리하는 리소스 저장소

REST API 설계 규칙

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

• resource는 동사보다 명사를, 대문자보다 소문자를 사용한다. 
  선례) '/users', '/products'
  반례) '/getuser' (동사여서 X), '/User' (대문자여서 X)
• resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
  선례 ) '/user/{id} ', '/product/{id} '
  반례 )'/users' (s가 들어가 단수 명사가 아님)
• resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
  선례) '/users', '/products'
  반례) '/user/{id}', 'productDetail/{id}' (복수 명사를 사용하지 않음)
• resource의 스토어 이름으로는 복수 명사를 사용해야 한다.
  선례) /users,  /products
  반례) '/user/{id}', 'productDetail/{id}' (복수 명사를 사용하지 않음)

2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE)로 표현된다.

• URI에 HTTP Method가 들어가면 안된다.
  선례) 'DELETE/user/{id}'
  반례) 'DELETE/user/delete/{id}' (delete가 들어가 있음)
• URI에 행위에 대한 동사 표현이 들어가면 안된다.
  선례) 'GET/user/{id}'
  반례) 'GET/user/insert/{id}', 'GET/user/show/{id}' (insert, show같은 동사 표현이 들어감)
• route(경로) 부분중 변하는 부분은 유일한 값으로 대체한다. (id=같은 특징)
  ex) POST/user/{id} -> POST/user/{123} (id는 고유값이라 123으로 대체)

3. 이외의 규칙

• (/) 슬래시 구분자는 계층 관계를 나타낸다.
  ex) http:://natureapi/coding.com/rests/apis
• URI 마지막 문자로 슬래시를 포함하지 않는다.
  슬래시 구분자는 계층 관계를 위해서 사용함으로 슬래시 사용 안한다.
  ex) http:://natureapi/coding.com/rests/apis/ -> ex) http:://natureapi/coding.com/rests/apis
• 하이폰(-)은 URI 가독성을 높이는데 사용한다.
  ex) /products/electronic-devices/smartphones
• 밑줄(_)은 URI에 사용하지 않는다.
  ex) /products/electronic_devices/smartphones -> /products/electronic-devices/smartphones
• 파일확장자는 URI에 포함하지 않는다.
  메세지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
  Accept header를 사용한다.
  ex) GET /users/123/json -> GET /users/123/ Accept: application/xml
• 리소스 간에 연관 관계가 있는 경우
  /리소스명/리소스 ID/관계가 있는 다른 리소스명
  ex) GET : /user/{userod}/devices

 

---

 

5. RESTful

이제 다왓다. RESTful은 REST라는 아키텍처를 구현하는 웹서비스를 나타내기 위해서 사용하는 언어이다.

즉 REST원리를 따르는 시스템은 RESTful이라는 용어로 지칭된다.

가령 CRUD 기능을 모두 POST로만 처리하는 API라든가 route에 resource,id정보가 들어가는 경우는 RESTful하지 못한다고 할수 있다.

RESTful 목적

1. 이해하기 쉽고 사용하기 쉬운 REST API를 만든 것
2. 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것
   성능 향상에 목적이 있는것이 아니다.

이제 RESTful API를 사용해보자

---

 

6. url 예시

앞에서 설명한 바에 따르면 RESTful api는 url로 만든다고 한다. user라는 자원을 가지고 만든 url를 만들어보자

http://localhost:8080/users

Resource	POST(create)	GET(read)	PUT(update)	UPDATE(delete)
/users	새로운 user를 생성	user들의 목록	user들에 대한 대량 업데이트	모든 users삭제
/user/1	erro	user id = 1 보기	user id = 1업데이트	user id =1 삭제

{

   "id" : 1

   "name" : "CODINGJADE:

   "email" : "CJ@daum.com"

}