[Node.js] 5. REST API

API란?

Application Programming Interface로 

서로 다른 프로그램간 소통할 수 있게 도와주는 통신규약을 뜻합니다.

이것을 웹에서 사용하면

'서버와 고객간의 통신규약'을 뜻하고

'서버에게 요청해서 데이터에 가져오는 방법'이 바로 API입니다.

 

REST

REST(Representational State Transfer)의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미합니다.

즉 REST란 

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

CRUD Operation이란
- CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말로 REST에서의 CRUD Operation 동작 예시는 다음과 같다.
- Create : 데이터 생성(POST)
  Read : 데이터 조회(GET)
  Update : 데이터 수정(PUT)
  Delete : 데이터 삭제(DELETE)

 

REST 구성 요소

REST는 다음과 같은 3가지로 구성이 되어있다. 

 

1. 자원(Resource) : HTTP URI
2. 자원에 대한 행위(Verb) : HTTP Method
3. 자원에 대한 행위의 내용 (Representations) : HTTP Message Pay Load

 

REST API 란?

Representational State Transfer 의 약자로 API 디자인 방법입니다.

6개의 원칙이있는데

 

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

인터페이스는 일관성이 있어야한다.

- 하나의 url로는 하나의 데이터를 가져와야한다

- 간결하고 예측가능하게 짠다

- URL 이름짓기 관습

• 단어들을 동사보다는 명사 위주로 구성함
• 응용해서 다른 정보들을 쉽게 가져올 수 있을 정도로 일관성 있음 
• 대충 봐도 어떤 정보가 들어올지 예측이 가능함
• 띄어쓰기는 언더바_대신 대시-기호-사용
• 파일 확장자 쓰지 말기 (.html 이런거)
• 하위 문서들을 뜻할 땐 / 기호를 사용함 (하위폴더같은 느낌)

 

2. Client-server 역할 구분하기 (서버-클라이언트 구조)

고객에게 서버역할을 맡기지않고 Server역할을 정하고 코드 짜기

 

3. Stateless (무상태)

요청들은 각각 독립적으로 처리되어야 한다. 

요청간 의존성이 존재하는 코드를 짜면 안된다. (요청하나만으로 자료를 가져오기 충분하도록, 요청에 필요한 모든정보를 실어보내기)

 

4. Cacheable (캐시처리 가능)

요청을 통해 보내는 자료들은 캐싱이 가능해야한다. (캐싱가능 표시. 캐싱 기간 설정)

 

5. Layered System (계층화)

요청처리하는 곳, DB에 저장하는 곳 이런 여러가지 단계를 거쳐서 요청을 처리해도 됨. 

여러개의 레이어를 거쳐 요청처리 만들기 시스템 가능.

 

6. Code on Demand

서버는 고객에게 실제 실행가능한 코드를 전송해줄 수 있다.

 

 

REST의 장단점

장점 

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

 

단점 

• 표준이 자체가 존재하지 않아 정의가 필요하다.
• 사용할 수 있는 메소드가 4가지밖에 없다.
• HTTP Method 형태가 제한적이다.
• 브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 정보의 값을 처리해야 하므로 전문성이 요구된다.
• 구형 브라우저에서 호환이 되지 않아 지원해주지 못하는 동작이 많다.(익스폴로어)

 

REST API

REST API란 REST의 원리를 따르는 API를 의미합니다.

하지만 REST API를 올바르게 설계하기 위해서는 지켜야 하는 몇가지 규칙이 있으며 해당 규칙을 알아 보겠습니다.

REST API 설계 예시

1. URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 한다.

Bad Example https://kang-ji.tistory.com/Category/
Good Example  https://kang-ji.tistory.com/category/  

 

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

Bad Example https://kang-ji.tistory.com/test/  
Good Example  https://kang-ji.tistory.com/test

 

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

Bad Example https://kang-ji.tistory.com/test_blog
Good Example  https://kang-ji.tistory.com/test-blog  

 

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

Bad Example https://kang-ji.tistory.com/photo.jpg  
Good Example  https://kang-ji.tistory.com/photo  

 

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

Bad Example https://kang-ji.tistory.com/delete-post/1  
Good Example  https://kang-ji.tistory.com/post/1  

 

RESTful

RESTFUL이란 REST의 원리를 따르는 시스템을 의미합니다.

하지만 REST를 사용했다 하여 모두가 RESTful 한 것은 아닙니다.  

REST API의 설계 규칙을 올바르게 지킨 시스템을 RESTful하다 말할 수 있으며

모든 CRUD 기능을 POST로 처리 하는 API 혹은 URI 규칙을 올바르게 지키지 않은 API는 

REST API의 설계 규칙을 올바르게 지키지 못한 시스템은

REST API를 사용하였지만 RESTful 하지 못한 시스템이라고 할 수 있습니다.

 

https://khj93.tistory.com/entry/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-REST-API%EB%9E%80-REST-RESTful%EC%9D%B4%EB%9E%80

[네트워크] REST API란? REST, RESTful이란?