[NodeJS+Express] 9. RESTful API란?

사용자로부터 데이터를 입력받아 DB에 저장하는 기능을 구현하기 전에

RESTful API 에 대한 개념을 알아보자!

 

1. 서버로의 요청

서버는 '요청'에 따른 처리를 하는 프로그램으로 한 줄 요약할 수 있다.

이때 요청을 아무런 방식으로 하는 것이 아닌 정해진 형식에 따라야 한다.

 

만약 유저가 서버에 요청을 할때에는

method 와 url 을 정확하게 명시해야한다.

 

1) method의 종류

GET : 데이터 받기 요청
POST : 데이터 보내기 요청
UPDATE, PUT : 데이터 수정 요청
DELETE : 데이터 삭제 요청
...

주로 사용하는 method의 종류는 위와 같다.

 

2) URL

/path명 과 같은 서버에 등록되어있는 url을 요청해야한다.

url은 endpoint 라고 표현하기도 한다.

 

 

3) API == method 와 URL 조합

method와 URL을 임의로 조합하는 것이 아니라

서버에 등록되어있는 조합을 요청해야한다.

 

이때 mothod와 URL의 조합이 API이다.

 

app.get(...)
app.post(...)
app.update(...)
app.delete(...)

서버파일에 이러한 형식으로 작성했던 것이 바로 API를 등록하는 것이다.

즉, 서버의 기능을 만드는 것이다!

 

예시

app.get('/', (request, response) => {
  response.sendFile(__dirname + '/index.html');
})

 

server.js(서버파일)에 이러한 코드를 넣었을때

root 페이지( / )로 GET 요청을 한다면 index.html을 보내겠다는 의미이다.

 

 

이러한 방식으로 API를 등록해놓으면

유저는 url에 접속하여 GET 요청을 하거나 <form>태그에 데이터를 입력한 후 POST 요청을 하는 등

상호작용을 할 수 있다.

 

---

2. REST API란? (간단 버전)

REST API(Representational State Transfer API)는

미국의 개발자 로이 필딩(Roy Fielding)이 창시한 REST 라는 개념을 따른 API를 말한다.

 

더 자세한 내용은 추후에 다룰 예정이다!

 

1) REST

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

 

1. HTTP URI(이름)를 통해 자원(Resource)을 명시하고,
2. HTTP Method(GET, POST, UPDATE, PUT, DELETE 등)를 통해
3. 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것!

 

2) REST API

위에서 설명한 REST 개념을 따른 API 즉, 좋은 API에 대해 정의한 것이다.

이를 위해서는 몇가지 따라야할 규칙이 있다.

 

[REST API 규칙]
1. Unifrom Interface
2. Client - Server 역할 구분
3. Stateless
4. Cacheable
5. Layered System
6. Code on demand

 

(1) Unifrom Interface

- URL은 일관성 있게

   e.g. 포스트의 URL이 /post 라면, /post/12312, /post/32123 등으로 일관성 있게 설계하자!
- 하나의 URL+method에서는 한 종류의 데이터를 가져오도록 설계

- 결과 예측이 가능하도록!

 

(2) Client - Server 역할 구분

- 클라이언트와 서버의 역할을 명확히 구분

  (유저가 서버역할을 한다거나 DB에 직접 입출력하지 않도록)

 

(3) Stateless

- 요청끼리 서로 의존성이 있지 않도록

 

(4) Cacheable

- 요청은 캐싱이 가능하게 (자주 수신되는 자료면 요청이 아니라 로컬저장)

 

(5) Layered System

- 요청하나는 최종 응답 전 여러단계 거쳐기 가능

 

(6) Code on demand

- 서버는 유저에게 실행가능한 코드를 보낼 수 있음

 

 

 

이러한 원칙들을 지킨다면 RESTful API 라고 불린다.

(요즘은 method, URL만 잘 기입하면 REST라고 한다고 함!)

 

3) 좋은 URL 작명법

- 단어보다 명사로!

- 띄어쓰기는 언더바(_) 대신 대시(-)로

- 파일 확장자를 그대로X

- 하위 문서일때는 트리형식으로 / 사용 (/~)